Skip to main content

​
Tools

Manage external tools that agents can use during calls.

​
List Tools

​
Get Tool

​
Create Tool

Body: name (required) and optional definition. If definition.modelToolName is omitted, it is derived from name. Create supports the X-Idempotency-Key header. Response: 201 Created with data (tool object) and meta. May return 422 if the tool definition is invalid (e.g. invalid schema or provider error). Minimal example (name only; definition can be configured later): 
{
  "name": "Lookup Customer"
}
Example with HTTP tool definition: 
{
  "name": "Lookup Customer",
  "definition": {
    "modelToolName": "lookup_customer",
    "type": "http",
    "http": {
      "url": "https://api.example.com/customer",
      "method": "GET"
    }
  }
}

​
Update Tool

Body: name and/or definition (partial update). Only included fields are updated. May return 422 if the definition is rejected (e.g. invalid schema).

​
Delete Tool