Skip to content

API Reference

Tools

Define the external functions your assistants can call: API integrations and dynamic transfers.

For a step-by-step walkthrough, read the Custom tools guide.

Endpoints

MethodPathPurpose
GET/toolsList tools
POST/toolsCreate tool
GET/tools/{id}Get tool
PUT/tools/{id}Replace tool
DELETE/tools/{id}Delete tool
PUT/tools/{id}/instructionReplace tools instruction
DELETE/tools/{id}/instructionDelete tools instruction
PUT/assistants/{id}/tools/{toolId}/steps/{stepId}/overrideSet step instruction override
DELETE/assistants/{id}/tools/{toolId}/steps/{stepId}/overrideRemove step instruction override
PUT/assistants/{id}/tools/{toolId}/description-overrideReplace assistants tools description override
GET/assistants/{id}/tools/{toolId}/overrideGet tool instruction overrides
DELETE/assistants/{id}/tools/{toolId}/overrideRemove tool instruction overrides
PUT/assistants/{id}/tools/{toolId}/steps/{stepId}/text-overrideReplace assistants tools steps text override
DELETE/assistants/{id}/tools/{toolId}/steps/{stepId}/text-overrideDelete assistants tools steps text override
PUT/assistants/{id}/tools/{toolId}/text-description-overrideReplace assistants tools text description override
GET/assistants/{id}/tools/{toolId}/text-overrideList assistants tools text override
DELETE/assistants/{id}/tools/{toolId}/text-overrideDelete assistants tools text override
Try it in the API Explorer