Happ Docsaccess-token Enter your Access Token (format: happ_...)
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/api/assistant-tools" \ -H "Content-Type: application/json" \ -d '{ "name": "create_order", "assistantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }'Tool (function) name the LLM calls; use snake_case
If true, tool execution will disable interruptions
falseHow the tool is executed
"webhook_action"Value in
Required for webhook types (webhook_action, webhook_postcall), not needed for client type
Explanation of what the tool does and when the LLM should call it
HTTP method for webhook types (webhook_action, webhook_postcall), not needed for client type
"POST"Value in
Execution mode: immediate - execute immediately, post_tool_speech - execute after speech, async - execute asynchronously
"immediate"Value in
JSON Schema for function parameters
Webhook secret for webhook_init tools
Sound file to play when tool is called
Value in
Structured parameter definitions the LLM fills when calling the tool
ID of the assistant the tool belongs to
uuid