Made in 10Docs
GuidesAPI
ReferenceTools

Create a tool

Makes a tool and answers its signing secret, the only time it is shown besides a rotation.

POST
/tools

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.

Request Body

application/json
  1. body
Example
{  "name": "order_status",  "description": "Looks up an order's status by its number.",  "parameters": {    "type": "object",    "properties": {      "order": {        "type": "string"      }    },    "required": [      "order"    ]  },  "url": "https://example.com/hooks/order-status",  "filler": "One moment while I check."}
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
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

Where it runs; it never changes after. A page tool takes no url and gets no secret.

Default"server"
Value in"server""page"
url?string

Required for a server tool. An https address, through the same rules as webhooks.

Formaturi
Lengthlength <= 2000
timeout_ms?integer

5000 for a server tool, 10000 for a page tool, unless given.

Range500 <= value <= 15000
filler?string
Lengthlength <= 200
enabled?boolean
Defaulttrue

Response Body

The tool and its secret. Keep the secret; it can't be read again.

application/json
  1. response
tool*

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}
secret*|

The signing secret; null for a page tool, which has none.

Example Request
curl -X POST 'https://api.daxov.com/v1/tools' \  -H 'Content-Type: application/json' \  -d '{  "name": "order_status",  "description": "Looks up an order'\''s status by its number.",  "parameters": {    "type": "object",    "properties": {      "order": {        "type": "string"      }    },    "required": [      "order"    ]  },  "url": "https://example.com/hooks/order-status",  "filler": "One moment while I check."}'
Example Response
{  "tool": {    "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  },  "secret": "whsec_BwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyAhIiMkJSY="}