Skip to main content
GET
/
v1
/
tools
List Platform Tools
curl --request GET \
  --url https://api.astralform.ai/v1/tools
[
  {
    "name": "tavily_search",
    "display_name": "Web Search",
    "description": "Search the web for current information",
    "icon": "globe"
  }
]

Documentation Index

Fetch the complete documentation index at: https://astralform.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Returns platform tools that the developer has enabled in the dashboard. Use this to show toggleable tool icons in your chat UI.

Response

Returns an array of available tools.
name
string
Tool identifier used in chat requests.
display_name
string
Human-readable name for UI display.
description
string
What the tool does.
icon
string
SF Symbol name for iOS (e.g., "globe", "magnifyingglass").
[
  {
    "name": "tavily_search",
    "display_name": "Web Search",
    "description": "Search the web for current information",
    "icon": "globe"
  }
]

Example

let tools = try await client.getAvailableTools()

for tool in tools {
    // Show tool toggle in UI
    ToolToggle(
        name: tool.displayName,
        icon: Image(systemName: tool.icon)
    )
}