Skip to main content
POST
voice.tool.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$

Response

The result

name
string
required

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
kind
enum<string>
required

Tool kind. code runs hosted code. function calls one of your own webhook endpoints (set endpoint) with a signed request and reads its text answer back to the agent. Other connection kinds need a later connection feature.

Available options:
end_call,
keypad,
voicemail,
handoff,
transfer,
code,
query,
api_request,
function,
mcp,
sip_request,
calendar,
sheets,
slack,
crm,
sms,
shell,
computer,
text_editor
parameters
object[]
required

Up to 20 scalar parameters for a code or function tool.

Maximum array length: 20
assistants
string[]
required

Owned assistant names for handoff or transfer.

Maximum array length: 20

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
timeoutSeconds
integer
default:10
required

Longest one use of a code or function tool may take, 1 to 30 seconds; for a function tool this includes retries.

Required range: 1 <= x <= 30
useSipInfo
boolean
default:false
required

Send keypad tones using SIP INFO.

detectBeep
boolean
default:false
required

Wait for a voicemail beep.

description
string

Tool description.

Maximum string length: 1000
code
string

Hosted code, up to 50,000 characters; no embedded secrets.

Required string length: 1 - 50000
endpoint
string

For a function tool: the id of one of your webhook endpoints. It must be enabled, use https and subscribe to voice.tool.call. The tool never holds a URL or a secret.

Pattern: ^we_[a-f0-9]{32}$
message
string

Message spoken when the tool starts.

Maximum string length: 1000