Create an API Tool
Create a reusable external HTTP tool.
Endpoint
POST/api-tools
Request
Response
json
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | Organization ID |
name | String | Yes | Internal tool name |
description | String | Yes | What the tool does |
endpoint | String | Yes | External HTTP endpoint |
method | String | Yes | HTTP method used by the assistant configuration UI, usually GET or POST |
headers | Object | No | Headers sent to the external API |
url_parameters | Array | No | Query or path parameters |
body_parameters | Array | No | JSON body parameters for POST tools |
parameters_schema | Object | No | OpenAI-style parameter schema |
response_example | Object | No | Example response to help users understand the tool |
POST Body Example
Next Step: Attach the Tool to an Assistant
After creating the tool, attach it with PATCH/ai-assistants/:id:
json
Report an issue with this documentation
Please log in to report issues with our documentation.