Create

Create a tool. For webhook tools, the response includes the HMAC webhook_secret exactly once — store it immediately; subsequent reads return a masked placeholder.

Authentication

AuthorizationBearer

Enter the key with the Bearer prefix, e.g. ‘Bearer API_KEY|ACCESS_TOKEN’.

Request

This endpoint expects an object.
namestringRequired
descriptionstringRequired
kindenumRequired

Where the tool executes.

  • system: worker-resident built-in (e.g. end_call, transfer_to_number)
  • webhook: worker signs a payload and POSTs it to your URL
  • client: worker dispatches to the caller’s browser/SDK via data channel
Allowed values:
configobjectRequired

Response

The created tool.
idstring
namestring
descriptionstring
kindenum

Where the tool executes.

  • system: worker-resident built-in (e.g. end_call, transfer_to_number)
  • webhook: worker signs a payload and POSTs it to your URL
  • client: worker dispatches to the caller’s browser/SDK via data channel
Allowed values:
configobject

One of SystemToolConfig, WebhookToolConfig, or ClientToolConfig depending on kind.

created_atdatetime
updated_atdatetime
webhook_secretstring

HMAC signing secret for kind=webhook. Returned in full only on the create response; all subsequent reads return a masked placeholder. Store it on first create — there is no way to retrieve it later.