Get a tool
One tool (never its secret), with the characters that take it.
secretKeyAuthorizationBearer <sk_live_… or sk_test_… (a prefix and 40 base62 characters)>A secret key from the dashboard, sent as Authorization: Bearer sk_live_…. Live keys run real, charged calls; test keys (sk_test_…) run calls of at most 60 seconds, 20 a day per organization, never charged. Each key sees only its own env's calls, meetings, webhooks, memories and analytics. Publishable keys (pk_…) are refused.
tool_id*stringThe tool's id.
^tool_[0-9A-Za-z]{20}$"tool_6Mx1Rb8QwT3kNv5LcZ9p"The tool.
application/json- response
A tool (never its secret).
{ "id": "tool_6Mx1Rb8QwT3kNv5LcZ9p", "name": "order_status", "description": "Looks up an order's status by its number.", "parameters": { "type": "object", "properties": { "order": { "type": "string" } }, "required": [ "order" ] }, "runs_on": "server", "url": "https://example.com/hooks/order-status", "timeout_ms": 5000, "filler": "One moment while I check.", "enabled": true, "character_ids": [ "chr_4fT9kQ2mXw7LbN3pZs8V" ], "previous_secret_until_unix": null, "created_unix": 1793300000, "updated_unix": 1793300000}id*ToolId^tool_[0-9A-Za-z]{20}$"tool_6Mx1Rb8QwT3kNv5LcZ9p"name*ToolNameA function name, one per organization: lower-case letters, digits and _, starting with a letter, at most 64. save_note, book_meeting, end_call and names starting acme_ are ours.
^[a-z][a-z0-9_]{0,63}$"order_status"description*stringWhat the mind reads to decide when to call it. Say what it does and when.
1 <= length <= 1000parameters*A JSON Schema object for the arguments: "type": "object" (added when left out), properties of schema objects, required among them; at most 16 KB. Left out, the tool takes no arguments.
{ "type": "object", "properties": { "order": { "type": "string", "description": "The order number, like A-17" } }, "required": [ "order" ]}runs_on?stringserver: your HTTPS endpoint (url), signed with the tool's secret. page: the visitor's web page answers it during a call in the website widget (TalkWidget.register_tool); no url, no secret. Fixed when the tool is made.
"server""page"url*|The endpoint of a server tool; null for a page tool.
uritimeout_ms*integer500 <= value <= 15000filler*|What the character says at once while it waits.
length <= 200enabled*booleanOff keeps it out of calls.
character_ids*array<>previous_secret_until_unix*|int64created_unix*UnixUnix seconds, UTC.
int641793300000updated_unix*UnixUnix seconds, UTC.
int641793300000curl -X GET 'https://api.daxov.com/v1/tools/tool_6Mx1Rb8QwT3kNv5LcZ9p'{ "id": "tool_6Mx1Rb8QwT3kNv5LcZ9p", "name": "order_status", "description": "Looks up an order's status by its number.", "parameters": { "type": "object", "properties": { "order": { "type": "string" } }, "required": [ "order" ] }, "runs_on": "server", "url": "https://example.com/hooks/order-status", "timeout_ms": 5000, "filler": "One moment while I check.", "enabled": true, "character_ids": [ "chr_4fT9kQ2mXw7LbN3pZs8V" ], "previous_secret_until_unix": null, "created_unix": 1793300000, "updated_unix": 1793300000}