Made in 10Docs
GuidesAPI
ReferenceTools

Get a tool

One tool (never its secret), with the characters that take it.

GET
/tools/{tool_id}

Authorization

secretKey
headerAuthorizationBearer <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.

Path Parameters

tool_id*string

The tool's id.

Match^tool_[0-9A-Za-z]{20}$
Example"tool_6Mx1Rb8QwT3kNv5LcZ9p"

Response Body

The tool.

application/json
  1. response

A tool (never its secret).

Example
{  "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
Match^tool_[0-9A-Za-z]{20}$
Example"tool_6Mx1Rb8QwT3kNv5LcZ9p"
name*ToolName

A 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.

Match^[a-z][a-z0-9_]{0,63}$
Example"order_status"
description*string

What the mind reads to decide when to call it. Say what it does and when.

Length1 <= length <= 1000
parameters*

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.

Example
{  "type": "object",  "properties": {    "order": {      "type": "string",      "description": "The order number, like A-17"    }  },  "required": [    "order"  ]}
runs_on?string

server: 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.

Value in"server""page"
url*|

The endpoint of a server tool; null for a page tool.

Formaturi
timeout_ms*integer
Range500 <= value <= 15000
filler*|

What the character says at once while it waits.

Lengthlength <= 200
enabled*boolean

Off keeps it out of calls.

character_ids*array<>
previous_secret_until_unix*|
Formatint64
created_unix*Unix

Unix seconds, UTC.

Formatint64
Example1793300000
updated_unix*Unix

Unix seconds, UTC.

Formatint64
Example1793300000
Example Request
curl -X GET 'https://api.daxov.com/v1/tools/tool_6Mx1Rb8QwT3kNv5LcZ9p'
Example Response
{  "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}