Skip to main content
GET
/
v1
/
toolkits
/
{toolkit_id}
/
tools
Get Toolkit Tools
curl --request GET \
  --url https://api.xpander.ai/v1/toolkits/{toolkit_id}/tools \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "send-email-tool-uuid",
    "name": "Send Email",
    "description": "Sends an email with HTML body content"
  }
]
Retrieve all tools within a specific toolkit, formatted in the tool calling structure compatible with AI model function calling.

Path Parameters

toolkit_id
string
required
Unique identifier of the toolkit (UUID format)

Response

Returns an array of tool definitions in OpenAI function calling format:
name
string
Tool function name used when calling the tool
description
string
Description of what the tool does and how it should be used
parameters
object
JSON Schema defining the tool’s input parameters

Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/toolkits/<toolkit-id>/tools"

Example Response

[
  {
    "name": "send_message",
    "description": "Send a message to a Slack channel or user",
    "parameters": {
      "type": "object",
      "properties": {
        "channel": {
          "type": "string",
          "description": "The Slack channel ID or name to send the message to"
        },
        "message": {
          "type": "string",
          "description": "The message content to send"
        },
        "thread_ts": {
          "type": "string",
          "description": "Optional thread timestamp to reply in a thread"
        }
      },
      "required": ["channel", "message"]
    }
  },
  {
    "name": "get_channels",
    "description": "List all Slack channels in the workspace",
    "parameters": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "description": "Maximum number of channels to return (default: 20)"
        }
      },
      "required": []
    }
  },
  {
    "name": "list_users",
    "description": "Get list of users in the Slack workspace",
    "parameters": {
      "type": "object",
      "properties": {
        "include_bot_users": {
          "type": "boolean",
          "description": "Whether to include bot users (default: false)"
        }
      },
      "required": []
    }
  }
]

Notes

  • Tool definitions follow the OpenAI function calling format for compatibility
  • Use the tool name field when invoking tools via Invoke Tool
  • Parameter schemas use JSON Schema format
  • Required parameters must be provided when calling the tool
  • Returns 404 if the toolkit is not found

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

toolkit_id
string
required

Response

Successful Response