Skip to navigation
Tools

Create a tool

Save a tool. Attach it to agents with POST /v1/agents/{id}/tools.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-z][a-z0-9_]{0,99}$"

snake_case function name, e.g. get_order_status

descriptionstringRequired10-2000 characters
What it does and when the agent should use it
urlstringRequired<=2000 characters

The API to call; {param} placeholders in the path or query

display_namestring or nullOptional<=255 characters
parametersobjectOptional

JSON Schema {type: object, properties, required}

methodstringOptionalDefaults to GET
headersmap from strings to stringsOptional

e.g. {X-Api-Key: …}; never returned

response_mappingmap from strings to strings or nullOptional

{name: dot.path} to keep from the response

timeoutintegerOptional1-30Defaults to 15

Response

Successful Response

Errors

422
Unprocessable Entity Error