Patch MCP is an MCP server published by com.patchmcp, hosted at www.patchmcp.com. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 48 tools, including get_capabilities, place_call, get_call, set_call_visibility, end_call.
AI phone calls from your verified number, with answers, transcripts and recordings.
8 connections through 4 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Start here to discover Patch actions, granted permissions, feature prerequisites and the next tools to call.
No parameters.
{
"name": "get_capabilities",
"description": "Start here to discover Patch actions, granted permissions, feature prerequisites and the next tools to call.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Place one real phone call FROM the selected outbound number (the authenticated user’s verified personal number by default) to accomplish a specific objective (book a table, ask a question, chase an order). A real-time voice agent handles the call, including automated phone menus and hold queues. Its default opening says who it is calling for and states the call's purpose. Use get_agent and update_agent for number settings and inbound greeting/instructions. Outbound greeting and system instructions are read-only through MCP; use objective and context for call-specific facts. Changes apply directly to new calls. Call facts are added automatically. The recording disclosure belongs in the first spoken turn that advances the objective, whether asking a question, making a request, or giving task-related details. Brief introductory chatter or an acknowledgment of a request to hold may come first. Naturally include “on a recorded line” in the introduction or response, using a natural equivalent in the selected call language. Returns immediately with a call_id and resolved locale, language, and voice; the call proceeds in the background and typically takes 2–5 minutes — poll get_call (pass wait_seconds to long-poll) until the status is terminal. The response includes a listen_url: a private web link where the user can hear the call live, watch the transcript, and stop the call — offer it to the user. Calls in Central America, Europe, North America, and South America, subject to route availability; never for emergencies. Calls involving a non-US/Canadian number require a paid plan from the first call. Rates vary by caller ID and destination; the response includes an estimated provider cost for one minute, including per-call costs. This estimate is not a final charge. Paid usage follows telephone, AI and any lookup costs, including unsuccessful attempts, and can update after the call. Calls can be placed at any time of day, any day of the week, and the user is responsible for fair use; one call runs at a time per account and volume is governed by the plan — rejections return a machine-readable `error` code with retry guidance, so relay the message to the user rather than retrying blindly. The voice agent receives the name of the person the call is for: if the account has no name on file the call is rejected with `user_name_required` — ask your user what name to give (e.g. "Sam" or "Sam at Acme"), then call again with it in `user_name`; it is saved to the account for future calls.
| Parameter | Type | Description |
|---|---|---|
| to |
Get the status and, once terminal, the structured resolution of a call started with place_call. Returns instantly by default. Pass wait_seconds (max 50) to have the server hold the request and return early on any status change — fewer round trips while a call is in progress. Terminal statuses: completed, answered_silently, no_answer, busy, voicemail, failed, rejected, canceled, declined_recording, opted_out. rejected means safety screening declined the objective before dialing; error.message and resolution.summary explain why. Terminal calls include a `resolution` {outcome: achieved|partially_achieved|not_achieved|no_conversation|unknown, summary, commitments[], follow_ups[], key_facts[]} — read it before the transcript; it is the answer. unknown means the outcome could not be determined; review the transcript. Completed calls also carry the transcript (may be marked transcript_truncated) and a recording_url the user can listen to (private links expire after ~1 hour; on staging, fetch with the same OAuth Authorization: Bearer header). The resolution can lag the terminal status by a few seconds while it is extracted. Calls include the resolved locale, language, voice, and is_public; public calls return token-free listen and recording URLs that remain accessible while public. Use set_call_visibility only when the user explicitly asks to publish or make private. Every call includes a listen_url — the call page for the user (live audio + transcript while in progress; recording + transcript once ended). ended_by='user' on a canceled call means the user deliberately stopped it from that page — don't retry. recording_status=processing means the LiveKit session recording is being finalized and copied to private storage separately from the result. A recording can fail or be unavailable. Call get_call again, or pass wait_seconds on an already-terminal call to wait for a recording state change.
| Parameter | Type | Description |
|---|---|---|
| call_id * | string | The id returned by place_call. |
| wait_seconds | integer | 0 (default) = instant status check. Up to 50 = server-side long-poll. |
Make a call owned by the authenticated user public or private. Calls are private by default. Only publish when the user explicitly asks: a public call exposes its objective, phone numbers, transcript, result and audio to anyone with its permanent, token-free listen_url, including live audio while in progress. Set is_public to false to disable token-free access again; existing private signed links remain valid until they expire. Public visitors cannot stop the call or change visibility.
| Parameter | Type | Description |
|---|---|---|
| call_id * | string | The id of a call owned by this account. |
| is_public * | boolean | true publishes the call; false makes it private again. |
{
"name": "set_call_visibility",
"description": "Make a call owned by the authenticated user public or private. Calls are private by default. Only publish when the user explicitly asks: a public call exposes its objective, phone numbers, transcript, result and audio to anyone with its permanent, token-free listen_url, including live audio while in progress. Set is_public to false to disable token-free access again; existing private signed links remain valid until they expire. Public visitors cannot stop the call or change visibility.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"call_id",
"is_public"
],
"properties": {
"call_id": {
"type": "string",
"description": "The id of a call owned by this account."
},
"is_public": {
"type": "boolean",
"description": "true publishes the call; false makes it private again."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"call_id",
"is_public",
"listen_url"
],
"properties": {
"call_id": {
"type": "string",
"description": "Call identifier used with get_call, end_call and set_call_visibility."
},
"is_public": {
"type": "boolean",
"description": "Updated visibility; public links expose call data."
},
"listen_url": {
"type": "string",
"description": "URL for the user to listen, read the transcript and stop an active call."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Machine-readable failure code."
},
"message": {
"type": "string",
"description": "Explanation or recovery guidance."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Successful result or a machine-readable tool error."
},
"annotations": {
"title": "Set call visibility",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}End an in-progress call early. Patch requests disconnection by deleting the LiveKit room; a spoken farewell is not guaranteed. Check get_call for the resulting status. Use when the user changes their mind or the call is no longer needed. Available transcript snapshots are retained and the resolution is extracted separately.
| Parameter | Type | Description |
|---|---|---|
| call_id * | string | The id returned by place_call. |
{
"name": "end_call",
"description": "End an in-progress call early. Patch requests disconnection by deleting the LiveKit room; a spoken farewell is not guaranteed. Check get_call for the resulting status. Use when the user changes their mind or the call is no longer needed. Available transcript snapshots are retained and the resolution is extracted separately.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"call_id"
],
"properties": {
"call_id": {
"type": "string",
"description": "The id returned by place_call."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"call_id",
"status",
"ended",
"message"
],
"properties": {
"ended": {
"type": "boolean",
"description": "Whether an end request was applied; false if already terminal."
},
"status": {
"enum": [
"queued",
"ringing",
"in_progress",
"completed",
"answered_silently",
"no_answer",
"busy",
"voicemail",
"failed",
"rejected",
"canceled",
"declined_recording",
"opted_out"
],
"type": "string",
"description": "Current call lifecycle state."
},
"call_id": {
"type": "string",
"description": "Call identifier used with get_call, end_call and set_call_visibility."
},
"message": {
"type": "string",
"description": "Wrap-up or already-ended explanation."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Machine-readable failure code."
},
"message": {
"type": "string",
"description": "Explanation or recovery guidance."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Successful result or a machine-readable tool error."
},
"annotations": {
"title": "End call",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List this account's phone numbers, active direction availability and default_number_id. Use verify_number_url to add a personal caller ID in the workspace. The user enters the code on Patch. Use number_id to select a source for place_call. Accepts calls:read or numbers:read; management settings and workspace_revision are included only with numbers:read. Does not expose agent instructions or voices.
No parameters.
{
"name": "list_phone_numbers",
"description": "List this account's phone numbers, active direction availability and default_number_id. Use verify_number_url to add a personal caller ID in the workspace. The user enters the code on Patch. Use number_id to select a source for place_call. Accepts calls:read or numbers:read; management settings and workspace_revision are included only with numbers:read. Does not expose agent instructions or voices.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"verify_number_url",
"default_number_id",
"phone_numbers"
],
"properties": {
"operation_id": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number_id",
"phone_number",
"label",
"kind",
"state",
"caller_id_status",
"inbound_enabled",
"outbound_enabled",
"inbound_configured",
"outbound_configured",
"is_default"
],
"properties": {
"kind": {
"enum": [
"caller",
"owned"
],
"type": "string"
},
"label": {
"type": "string"
},
"state": {
"enum": [
"provisioning",
"requirements",
"active",
"suspended",
"release_pending",
"released",
"failed"
],
"type": "string"
},
"settings": {
"type": "object",
"required": [
"country",
"revision",
"retained",
"voice_system",
"release_at"
],
"properties": {
"country": {
"type": "string"
},
"retained": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"release_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"voice_system": {
"enum": [
"cascade",
"full_duplex"
],
"type": "string",
"description": "cascade, or full_duplex (GPT Live with Patch's custom voices). Change it with update_phone_number."
}
},
"description": "Number-management settings, included only with numbers:read permission.",
"additionalProperties": false
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"is_default": {
"type": "boolean"
},
"phone_number": {
"type": "string"
},
"inbound_enabled": {
"type": "boolean"
},
"caller_id_status": {
"enum": [
"verified",
"unverified"
],
"type": "string"
},
"outbound_enabled": {
"type": "boolean"
},
"inbound_configured": {
"type": "boolean"
},
"outbound_configured": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"default_number_id": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
]
},
"verify_number_url": {
"type": "string",
"format": "uri"
},
"workspace_revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Included only with numbers:read; use when changing the default number."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read one owned number by number_id; omit it to inspect the default outbound number. Accepts calls:read or numbers:read. Number-management settings, revision, recovery deadline and workspace_revision require numbers:read. Does not place a call or expose agent instructions or voices.
| Parameter | Type | Description |
|---|---|---|
| number_id | string |
{
"name": "get_phone_number",
"description": "Read one owned number by number_id; omit it to inspect the default outbound number. Accepts calls:read or numbers:read. Number-management settings, revision, recovery deadline and workspace_revision require numbers:read. Does not place a call or expose agent instructions or voices.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"number_id",
"phone_number",
"label",
"kind",
"state",
"caller_id_status",
"inbound_enabled",
"outbound_enabled",
"inbound_configured",
"outbound_configured",
"is_default"
],
"properties": {
"kind": {
"enum": [
"caller",
"owned"
],
"type": "string"
},
"label": {
"type": "string"
},
"state": {
"enum": [
"provisioning",
"requirements",
"active",
"suspended",
"release_pending",
"released",
"failed"
],
"type": "string"
},
"settings": {
"type": "object",
"required": [
"country",
"revision",
"retained",
"voice_system",
"release_at"
],
"properties": {
"country": {
"type": "string"
},
"retained": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"release_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"voice_system": {
"enum": [
"cascade",
"full_duplex"
],
"type": "string",
"description": "cascade, or full_duplex (GPT Live with Patch's custom voices). Change it with update_phone_number."
}
},
"description": "Number-management settings, included only with numbers:read permission.",
"additionalProperties": false
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"is_default": {
"type": "boolean"
},
"operation_id": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"inbound_enabled": {
"type": "boolean"
},
"caller_id_status": {
"enum": [
"verified",
"unverified"
],
"type": "string"
},
"outbound_enabled": {
"type": "boolean"
},
"inbound_configured": {
"type": "boolean"
},
"workspace_revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Included only with numbers:read; use when changing the default number."
},
"outbound_configured": {
"type": "boolean"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read owned history newest first. kind=call (default) requires calls:read and returns call statuses, resolution summaries/outcomes and listen links. kind=test requires configuration:read and returns finished synthetic tests. kind=all requires both permissions. Pass next_cursor unchanged with the same kind to fetch older entries.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | one of ["call","test","all"] |
| limit * | integer | |
| cursor | string |
{
"name": "list_activity",
"description": "Read owned history newest first. kind=call (default) requires calls:read and returns call statuses, resolution summaries/outcomes and listen links. kind=test requires configuration:read and returns finished synthetic tests. kind=all requires both permissions. Pass next_cursor unchanged with the same kind to fetch older entries.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"kind",
"limit"
],
"properties": {
"kind": {
"enum": [
"call",
"test",
"all"
],
"type": "string",
"default": "call"
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string",
"maxLength": 512,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"kind",
"activities",
"next_cursor"
],
"properties": {
"kind": {
"enum": [
"call",
"test",
"all"
],
"type": "string"
},
"activities": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"created_at",
"number_id",
"direction",
"status",
"duration_seconds",
"summary",
"kind",
"call_id",
"from",
"to",
"callee_name",
"objective",
"is_public",
"listen_url",
"outcome"
],
"properties": {
"to": {
"type": "string"
},
"from": {
"type": "string"
},
"kind": {
"type": "string",
"const": "call"
},
"status": {
"type": "string"
},
"call_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"outcome": {
"anyOf": [
{
"enum": [
"achieved",
"partially_achieved",
"not_achieved",
"no_conversation",
"unknown",
"pending"
],
"type": "string"
},
{
"type": "null"
}
]
},
"summary": {
"type": [
"string",
"null"
]
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"is_public": {
"type": "boolean"
},
"number_id": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
]
},
"objective": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"listen_url": {
"type": "string"
},
"callee_name": {
"type": [
"string",
"null"
]
},
"duration_seconds": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"created_at",
"number_id",
"direction",
"status",
"duration_seconds",
"summary",
"kind",
"test_id",
"scenario",
"title"
],
"properties": {
"kind": {
"type": "string",
"const": "test"
},
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"test_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"scenario": {
"type": "string"
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"duration_seconds": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read your profile, caller verification, revision, account defaults, setup progress and notices. For a sign-in email change, give the account owner change_sign_in_email_url to confirm both inboxes on Patch. Use update_account for other profile changes and set_onboarding for setup state.
No parameters.
{
"name": "get_account",
"description": "Read your profile, caller verification, revision, account defaults, setup progress and notices. For a sign-in email change, give the account owner change_sign_in_email_url to confirm both inboxes on Patch. Use update_account for other profile changes and set_onboarding for setup state.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"account",
"change_sign_in_email_url",
"onboarding",
"notices"
],
"properties": {
"account": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"notices": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"message",
"created_at"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"message": {
"type": "string"
},
"created_at": {
"type": "string"
}
},
"additionalProperties": false
}
},
"onboarding": {
"anyOf": [
{
"type": "object",
"required": [
"required",
"intent",
"trialEligible",
"inboundAvailable"
],
"properties": {
"intent": {
"anyOf": [
{
"enum": [
"inbound",
"outbound",
"both"
],
"type": "string"
},
{
"type": "null"
}
]
},
"required": {
"type": "boolean"
},
"trialEligible": {
"type": "boolean"
},
"inboundAvailable": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"operation_id": {
"type": "string"
},
"change_sign_in_email_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Update supplied profile, language, voice and pronunciation defaults using the revision from get_account. Each number's voice system is set with update_phone_number. Language and voice defaults require configuration permission. Internal system prompts are not exposed through MCP.
| Parameter | Type | Description |
|---|---|---|
| changes * | object | |
| revision * | any |
{
"name": "update_account",
"description": "Update supplied profile, language, voice and pronunciation defaults using the revision from get_account. Each number's voice system is set with update_phone_number. Language and voice defaults require configuration permission. Internal system prompts are not exposed through MCP.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"revision",
"changes"
],
"properties": {
"changes": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 60,
"minLength": 1
},
{
"type": "null"
}
]
},
"call_locale": {
"type": "string"
},
"voices_by_locale": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"pronunciation_overrides": {
"type": "array",
"items": {
"type": "object",
"required": [
"word",
"pronunciation"
],
"properties": {
"word": {
"type": "string",
"pattern": "^[\\p{L}\\p{M}\\p{N} .’'-]+$",
"maxLength": 64,
"minLength": 1
},
"pronunciation": {
"type": "string",
"pattern": "^[\\p{L}\\p{M}\\p{N} .’'-]+$",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 50
}
},
"additionalProperties": false
},
"revision": {
"anyOf": [
{
"type": "string",
"pattern": "^account_[a-f0-9]{64}$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Save only setup progress: choose inbound/outbound intent and mark the checklist checkout, complete or skipped. Checkout records progress only; this tool never opens payment, buys a plan or acquires a number.
| Parameter | Type | Description |
|---|---|---|
| intent | string | one of ["inbound","outbound","both"] |
| status * | string | one of ["checkout","complete","skipped"] |
{
"name": "set_onboarding",
"description": "Save only setup progress: choose inbound/outbound intent and mark the checklist checkout, complete or skipped. Checkout records progress only; this tool never opens payment, buys a plan or acquires a number.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"status"
],
"properties": {
"intent": {
"enum": [
"inbound",
"outbound",
"both"
],
"type": "string"
},
"status": {
"enum": [
"checkout",
"complete",
"skipped"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"onboarding"
],
"properties": {
"onboarding": {
"type": "object",
"required": [
"required",
"intent",
"trialEligible",
"inboundAvailable"
],
"properties": {
"intent": {
"anyOf": [
{
"enum": [
"inbound",
"outbound",
"both"
],
"type": "string"
},
{
"type": "null"
}
]
},
"required": {
"type": "boolean"
},
"trialEligible": {
"type": "boolean"
},
"inboundAvailable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List applications authorized to access this account. These are distinct from external tools used by voice agents.
No parameters.
{
"name": "list_authorized_apps",
"description": "List applications authorized to access this account. These are distinct from external tools used by voice agents.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"apps"
],
"properties": {
"apps": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Disconnect an authorized application. Revoking the current application ends this MCP connection.
| Parameter | Type | Description |
|---|---|---|
| client_id * | string |
{
"name": "revoke_authorized_app",
"description": "Disconnect an authorized application. Revoking the current application ends this MCP connection.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"client_id"
],
"properties": {
"client_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Find the identifiers and revisions of your inbound and outbound agents.
No parameters.
{
"name": "list_agents",
"description": "Find the identifiers and revisions of your inbound and outbound agents.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"agents"
],
"properties": {
"agents": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Find included US or Canadian numbers. Plus automatically prefers any unclaimed Patch number in the requested country, then falls back to area-code search. Pro plans use area-code search so the user can choose a number. Plus can use reuse_only without an area code to check its existing inventory. Offers expire; claim the chosen offer.
| Parameter | Type | Description |
|---|---|---|
| country * | string | one of ["US","CA"] |
| area_code | string | |
| reuse_only * | boolean |
{
"name": "search_phone_numbers",
"description": "Find included US or Canadian numbers. Plus automatically prefers any unclaimed Patch number in the requested country, then falls back to area-code search. Pro plans use area-code search so the user can choose a number. Plus can use reuse_only without an area code to check its existing inventory. Offers expire; claim the chosen offer.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"country",
"reuse_only"
],
"properties": {
"country": {
"enum": [
"US",
"CA"
],
"type": "string"
},
"area_code": {
"type": "string",
"pattern": "^\\d{3}$"
},
"reuse_only": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"offers"
],
"properties": {
"offers": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Acquire an offered number using your plan allowance. Reuse request_id after an interrupted response.
| Parameter | Type | Description |
|---|---|---|
| label * | string | |
| offer_id * | string | |
| request_id * | string |
{
"name": "claim_phone_number",
"description": "Acquire an offered number using your plan allowance. Reuse request_id after an interrupted response.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"offer_id",
"label",
"request_id"
],
"properties": {
"label": {
"type": "string",
"default": "",
"maxLength": 60
},
"offer_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Read provisioning progress for a number claim.
| Parameter | Type | Description |
|---|---|---|
| claim_id * | string |
{
"name": "get_number_claim",
"description": "Read provisioning progress for a number claim.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"claim_id"
],
"properties": {
"claim_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Change a label, inbound/outbound availability, retention preference or voice system using the number revision. voice_system is cascade (default: speech-to-text, a language model, then a voice from the full catalog) or full_duplex (GPT Live, which listens while it speaks, with Patch's custom voices; see list_voices); it applies to the number's inbound and outbound calls and tests from the next one, without republishing. Enabling an unpublished direction activates its initial defaults; saved drafts and existing live settings are preserved.
| Parameter | Type | Description |
|---|---|---|
| label | string | |
| inbound | boolean | |
| outbound | boolean | |
| retained | boolean | |
| revision * | integer | |
| number_id * | string | |
| voice_system | string | one of ["cascade","full_duplex"] |
{
"name": "update_phone_number",
"description": "Change a label, inbound/outbound availability, retention preference or voice system using the number revision. voice_system is cascade (default: speech-to-text, a language model, then a voice from the full catalog) or full_duplex (GPT Live, which listens while it speaks, with Patch's custom voices; see list_voices); it applies to the number's inbound and outbound calls and tests from the next one, without republishing. Enabling an unpublished direction activates its initial defaults; saved drafts and existing live settings are preserved.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"revision"
],
"properties": {
"label": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"inbound": {
"type": "boolean"
},
"outbound": {
"type": "boolean"
},
"retained": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"voice_system": {
"enum": [
"cascade",
"full_duplex"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Choose the default outbound number using workspace_revision from get_phone_number.
| Parameter | Type | Description |
|---|---|---|
| number_id * | string | |
| workspace_revision * | integer |
{
"name": "set_default_phone_number",
"description": "Choose the default outbound number using workspace_revision from get_phone_number.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"workspace_revision"
],
"properties": {
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"workspace_revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Suggest forwarding instructions for the verified personal number during inbound onboarding. Carrier lookups are cached for a day.
No parameters.
{
"name": "get_forwarding_carrier",
"description": "Suggest forwarding instructions for the verified personal number during inbound onboarding. Carrier lookups are cached for a day.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Get carrier-specific steps for forwarding an existing phone to an owned Patch number. The user or carrier must activate forwarding; Patch cannot activate it remotely.
| Parameter | Type | Description |
|---|---|---|
| mode * | string | one of ["missed","all"] |
| provider | string | |
| number_id * | string |
{
"name": "get_forwarding_instructions",
"description": "Get carrier-specific steps for forwarding an existing phone to an owned Patch number. The user or carrier must activate forwarding; Patch cannot activate it remotely.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"mode"
],
"properties": {
"mode": {
"enum": [
"missed",
"all"
],
"type": "string",
"default": "missed"
},
"provider": {
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read active user-configurable settings and revision. Inbound includes editable greeting/instructions; outbound prompt text and Patch internal system prompts are not exposed. Settings are null until configured.
| Parameter | Type | Description |
|---|---|---|
| direction * | string | one of ["inbound","outbound"] |
| number_id * | string |
{
"name": "get_agent",
"description": "Read active user-configurable settings and revision. Inbound includes editable greeting/instructions; outbound prompt text and Patch internal system prompts are not exposed. Settings are null until configured.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"direction"
],
"properties": {
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"oneOf": [
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "outbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone",
"greeting",
"instructions"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"greeting": {
"type": "string",
"maxLength": 4000
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"instructions": {
"type": "string",
"maxLength": 40000
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
},
"additionalGreetings": {
"type": "array",
"items": {
"type": "string",
"maxLength": 600
},
"maxItems": 9
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "inbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Apply supplied settings directly to an agent for future calls using the revision from get_agent. Inbound greeting and instructions are editable; inbound additionalGreetings lists lines spoken after the greeting, in order, each as its own turn; a line may be in another language, and an empty list removes them. Outbound greeting and system instructions are not exposed or editable through MCP; supply per-call facts in place_call objective and context. backgroundSound plays ambient sound behind the agent's voice for the whole call (none, office, crowd, city or forest); backgroundVolume scales it from 0.25 to 2, where 1 is the default level. Use set_agent_connectors separately for external connections.
No parameters.
{
"name": "update_agent",
"description": "Apply supplied settings directly to an agent for future calls using the revision from get_agent. Inbound greeting and instructions are editable; inbound additionalGreetings lists lines spoken after the greeting, in order, each as its own turn; a line may be in another language, and an empty list removes them. Outbound greeting and system instructions are not exposed or editable through MCP; supply per-call facts in place_call objective and context. backgroundSound plays ambient sound behind the agent's voice for the whole call (none, office, crowd, city or forest); backgroundVolume scales it from 0.25 to 2, where 1 is the default level. Use set_agent_connectors separately for external connections.",
"inputSchema": {
"type": "object",
"oneOf": [
{
"type": "object",
"required": [
"number_id",
"direction",
"revision",
"changes"
],
"properties": {
"changes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string"
},
"speed": {
"type": "number",
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string"
},
"greeting": {
"type": "string",
"maxLength": 4000
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string"
},
"phonicVoice": {
"type": "string"
},
"gptLiveVoice": {
"type": "string"
},
"instructions": {
"type": "string",
"maxLength": 40000
},
"voicesByLocale": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string"
},
"backgroundVolume": {
"type": "number",
"maximum": 2,
"minimum": 0.25
},
"greetingExpression": {
"type": "string",
"maxLength": 6000
},
"additionalGreetings": {
"type": "array",
"items": {
"type": "string",
"maxLength": 600
},
"maxItems": 9
}
},
"additionalProperties": false
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"type": "string",
"const": "inbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"number_id",
"direction",
"revision",
"changes"
],
"properties": {
"changes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string"
},
"speed": {
"type": "number",
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string"
},
"phonicVoice": {
"type": "string"
},
"gptLiveVoice": {
"type": "string"
},
"voicesByLocale": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string"
},
"backgroundVolume": {
"type": "number",
"maximum": 2,
"minimum": 0.25
},
"greetingExpression": {
"type": "string",
"maxLength": 6000
}
},
"additionalProperties": false
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"type": "string",
"const": "outbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"oneOf": [
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "outbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone",
"greeting",
"instructions"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"greeting": {
"type": "string",
"maxLength": 4000
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"instructions": {
"type": "string",
"maxLength": 40000
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
},
"additionalGreetings": {
"type": "array",
"items": {
"type": "string",
"maxLength": 600
},
"maxItems": 9
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "inbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Reset user-configurable agent settings to defaults for future calls. Removes active external connection assignments and requires connector permission when assignments exist.
| Parameter | Type | Description |
|---|---|---|
| revision * | integer | |
| direction * | string | one of ["inbound","outbound"] |
| number_id * | string |
{
"name": "reset_agent",
"description": "Reset user-configurable agent settings to defaults for future calls. Removes active external connection assignments and requires connector permission when assignments exist.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"direction",
"revision"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"oneOf": [
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "outbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"number_id",
"enabled",
"revision",
"direction",
"settings"
],
"properties": {
"enabled": {
"type": "boolean"
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"settings": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"voice",
"speed",
"backgroundSound",
"backgroundVolume",
"language",
"mcpConnectorIds",
"voicesByLocale",
"hours",
"fallback",
"timezone",
"greeting",
"instructions"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"hours": {
"enum": [
"Always available",
"Weekdays, 9am–5pm"
],
"type": "string",
"default": "Always available"
},
"speed": {
"type": "number",
"default": 1.05,
"maximum": 1.5,
"minimum": 0.7
},
"voice": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"fallback": {
"enum": [
"Take a message",
"Decline call"
],
"type": "string",
"default": "Take a message"
},
"greeting": {
"type": "string",
"maxLength": 4000
},
"language": {
"type": "string",
"maxLength": 20
},
"timezone": {
"type": "string",
"default": "America/Chicago"
},
"gptLiveVoice": {
"type": "string"
},
"instructions": {
"type": "string",
"maxLength": 40000
},
"voicesByLocale": {
"type": "object",
"default": {},
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 100
}
},
"backgroundSound": {
"enum": [
"none",
"office",
"crowd",
"city",
"forest"
],
"type": "string",
"default": "none"
},
"mcpConnectorIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^mc_[a-f0-9]{32}$"
},
"default": [],
"maxItems": 10
},
"backgroundVolume": {
"type": "number",
"default": 1,
"maximum": 2,
"minimum": 0.25
},
"additionalGreetings": {
"type": "array",
"items": {
"type": "string",
"maxLength": 600
},
"maxItems": 9
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"direction": {
"type": "string",
"const": "inbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}List voices for a voice system (voice_system from get_phone_number; default cascade). Cascade offers six Cartesia Sonic 3.6 voices and six xAI Grok voices, the same set in every language: assign one with voice in update_agent. Full Duplex offers the custom voices made in Patch's OpenAI project, the same set in every language: assign an ID with gptLiveVoice in update_agent. speed (0.7 to 1.5, where 1 is the natural pace) sets the speaking rate of a Grok voice; Cartesia voices keep their own pace.
| Parameter | Type | Description |
|---|---|---|
| voice_system * | string | one of ["cascade","full_duplex"] |
{
"name": "list_voices",
"description": "List voices for a voice system (voice_system from get_phone_number; default cascade). Cascade offers six Cartesia Sonic 3.6 voices and six xAI Grok voices, the same set in every language: assign one with voice in update_agent. Full Duplex offers the custom voices made in Patch's OpenAI project, the same set in every language: assign an ID with gptLiveVoice in update_agent. speed (0.7 to 1.5, where 1 is the natural pace) sets the speaking rate of a Grok voice; Cartesia voices keep their own pace.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"voice_system"
],
"properties": {
"voice_system": {
"enum": [
"cascade",
"full_duplex"
],
"type": "string",
"default": "cascade"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"languages",
"regions"
],
"properties": {
"regions": {
"type": "array",
"items": {
"type": "object",
"required": [
"locale",
"label",
"voices"
],
"properties": {
"label": {
"type": "string"
},
"locale": {
"type": "string"
},
"voices": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider_voice_id",
"label"
],
"properties": {
"group": {
"type": "string",
"description": "Voice picker group for GPT Live voices."
},
"label": {
"type": "string"
},
"accent": {
"type": "string"
},
"gender": {
"enum": [
"female",
"male",
"neutral"
],
"type": "string"
},
"sample": {
"type": "string",
"format": "uri"
},
"provider": {
"enum": [
"cartesia",
"xai"
],
"type": "string",
"description": "Who supplies a Standard voice: Cartesia or xAI (Grok)."
},
"description": {
"type": "string",
"description": "The voice's tone."
},
"provider_voice_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Voice ID used when assigning a catalog voice to an agent."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"languages": {
"type": "array",
"items": {
"type": "object",
"required": [
"locale",
"label"
],
"properties": {
"label": {
"type": "string"
},
"locale": {
"type": "string"
}
},
"additionalProperties": false
}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get a short-lived playable URL for the Claudia persona's sample, using her provider_voice_id. Catalog voices from list_voices already include sample URLs.
| Parameter | Type | Description |
|---|---|---|
| provider_voice_id * | string |
{
"name": "get_voice_preview",
"description": "Get a short-lived playable URL for the Claudia persona's sample, using her provider_voice_id. Catalog voices from list_voices already include sample URLs.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider_voice_id"
],
"properties": {
"provider_voice_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"url",
"expires_in_seconds"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"operation_id": {
"type": "string"
},
"expires_in_seconds": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read this account's saved voice-agent connections, authorization state and common providers. Returns setup_url for entering API keys or custom OAuth credentials on the website. Reads stored metadata only; does not contact providers, discover tools, assign agents or invoke external actions.
No parameters.
{
"name": "list_connectors",
"description": "Read this account's saved voice-agent connections, authorization state and common providers. Returns setup_url for entering API keys or custom OAuth credentials on the website. Reads stored metadata only; does not contact providers, discover tools, assign agents or invoke external actions.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"available",
"callback_url",
"setup_url",
"common_connectors",
"connectors"
],
"properties": {
"available": {
"type": "boolean"
},
"setup_url": {
"type": "string",
"format": "uri"
},
"connectors": {
"type": "array",
"items": {
"type": "object",
"required": [
"connector_id",
"name",
"url",
"transport",
"auth_type",
"status",
"tool_count"
],
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"auth_type": {
"enum": [
"none",
"token",
"oauth"
],
"type": "string"
},
"transport": {
"enum": [
"http",
"sse"
],
"type": "string"
},
"tool_count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
},
"callback_url": {
"type": "string"
},
"operation_id": {
"type": "string"
},
"common_connectors": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider",
"name",
"description",
"premium_locked",
"available",
"connector_id"
],
"properties": {
"name": {
"type": "string"
},
"provider": {
"type": "string",
"const": "exa"
},
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"connector_id": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
]
},
"premium_locked": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the cached individual tool definitions for an owned connection. These functions are exposed separately to the voice agent on calls after set_agent_connectors assigns the connection. This read does not invoke them, refresh discovery or return credentials.
| Parameter | Type | Description |
|---|---|---|
| connector_id * | string |
{
"name": "get_connector_tools",
"description": "Read the cached individual tool definitions for an owned connection. These functions are exposed separately to the voice agent on calls after set_agent_connectors assigns the connection. This read does not invoke them, refresh discovery or return credentials.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"connector_id",
"execution_context",
"status",
"tools"
],
"properties": {
"tools": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"inputSchema"
],
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"annotations": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"readOnlyHint": {
"type": "boolean"
},
"openWorldHint": {
"type": "boolean"
},
"idempotentHint": {
"type": "boolean"
},
"destructiveHint": {
"type": "boolean"
}
},
"additionalProperties": {}
},
"description": {
"type": "string"
},
"inputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "object"
}
},
"additionalProperties": {}
},
"outputSchema": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "object"
}
},
"additionalProperties": {}
}
},
"additionalProperties": {}
}
},
"status": {
"type": "string"
},
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"operation_id": {
"type": "string"
},
"execution_context": {
"type": "string",
"const": "voice_agent"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Save a hosted voice-agent MCP connection requiring no credentials or standard browser OAuth, without contacting it or assigning agents. Never ask for or submit API keys, tokens, client secrets or credential-bearing URLs in chat. For API-key or custom OAuth setup, send the user to setup_url from list_connectors, then use the saved connector_id. Next use connect_connector for browser authorization and discovery, then set_agent_connectors to grant access.
| Parameter | Type | Description |
|---|---|---|
| url * | string | |
| name * | string | |
| authType * | string | one of ["none","oauth"] |
| transport * | string | one of ["http","sse"] |
| request_id * | string |
{
"name": "create_connector",
"description": "Save a hosted voice-agent MCP connection requiring no credentials or standard browser OAuth, without contacting it or assigning agents. Never ask for or submit API keys, tokens, client secrets or credential-bearing URLs in chat. For API-key or custom OAuth setup, send the user to setup_url from list_connectors, then use the saved connector_id. Next use connect_connector for browser authorization and discovery, then set_agent_connectors to grant access.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"url",
"transport",
"authType",
"request_id"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 2048
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"authType": {
"enum": [
"none",
"oauth"
],
"type": "string"
},
"transport": {
"enum": [
"http",
"sse"
],
"type": "string",
"default": "http"
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Contact an owned connection to discover or refresh its individual voice-agent tools. May begin third-party OAuth and return authorization_url for the user to approve; never collect verification codes or credentials in chat. Does not invoke external tools or change agent assignments. Inspect get_connector_tools after authorization.
| Parameter | Type | Description |
|---|---|---|
| request_id * | string | |
| connector_id * | string |
{
"name": "connect_connector",
"description": "Contact an owned connection to discover or refresh its individual voice-agent tools. May begin third-party OAuth and return authorization_url for the user to approve; never collect verification codes or credentials in chat. Does not invoke external tools or change agent assignments. Inspect get_connector_tools after authorization.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"connector_id",
"request_id"
],
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"connector_id",
"status"
],
"properties": {
"status": {
"enum": [
"connected",
"authorization_required"
],
"type": "string"
},
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"operation_id": {
"type": "string"
},
"authorization_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Create or return a managed Exa web-search connection using this account's existing paid entitlement. New connections are unassigned. Does not subscribe, charge, search, discover tools or change assignments. Next use connect_connector, inspect get_connector_tools and explicitly set_agent_connectors.
| Parameter | Type | Description |
|---|---|---|
| provider * | string | one of ["exa"] |
| request_id * | string |
{
"name": "add_common_connector",
"description": "Create or return a managed Exa web-search connection using this account's existing paid entitlement. New connections are unassigned. Does not subscribe, charge, search, discover tools or change assignments. Next use connect_connector, inspect get_connector_tools and explicitly set_agent_connectors.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"request_id"
],
"properties": {
"provider": {
"enum": [
"exa"
],
"type": "string"
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Replace the external connections available to one active voice agent for future calls. Review get_connector_tools and obtain authorization for those capabilities first. Every discovered function is exposed individually to the voice agent; it may invoke those external actions within its call instructions. An empty connector_ids list removes access. Does not invoke tools or change unrelated agent settings.
| Parameter | Type | Description |
|---|---|---|
| revision * | integer | |
| direction * | string | one of ["inbound","outbound"] |
| number_id * | string | |
| connector_ids * | array |
{
"name": "set_agent_connectors",
"description": "Replace the external connections available to one active voice agent for future calls. Review get_connector_tools and obtain authorization for those capabilities first. Every discovered function is exposed individually to the voice agent; it may invoke those external actions within its call instructions. An empty connector_ids list removes access. Does not invoke tools or change unrelated agent settings.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"direction",
"revision",
"connector_ids"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"connector_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 10
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"number_id",
"direction",
"revision",
"connector_ids"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"operation_id": {
"type": "string"
},
"connector_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Delete an owned connection and its saved credentials. Also revoke that connection from every assigned agent without applying unrelated settings. Requires configuration permission when an agent assignment is removed. Does not invoke external tools or revoke consent at the third-party provider.
| Parameter | Type | Description |
|---|---|---|
| request_id * | string | |
| connector_id * | string |
{
"name": "remove_connector",
"description": "Delete an owned connection and its saved credentials. Also revoke that connection from every assigned agent without applying unrelated settings. Requires configuration permission when an agent assignment is removed. Does not invoke external tools or revoke consent at the third-party provider.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"connector_id",
"request_id"
],
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"connector_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok",
"affected_agents"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
},
"affected_agents": {
"type": "array",
"items": {
"type": "object",
"required": [
"number_id",
"direction",
"revision"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}List synthetic test scenarios and available responder outcomes. Tests use fictional data and never invoke connected external tools.
No parameters.
{
"name": "list_test_scenarios",
"description": "List synthetic test scenarios and available responder outcomes. Tests use fictional data and never invoke connected external tools.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"scenarios"
],
"properties": {
"scenarios": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Draft a new test scenario from the active agent context, or expand an existing description with realistic complications. New mode ignores description. Returns editable text without starting a call.
| Parameter | Type | Description |
|---|---|---|
| mode * | string | one of ["new","expand"] |
| callMode * | string | one of ["bot","real"] |
| numberId * | string | |
| revision * | integer | |
| direction * | string | one of ["inbound","outbound"] |
| description | string | |
| destination | string |
{
"name": "generate_test_scenario",
"description": "Draft a new test scenario from the active agent context, or expand an existing description with realistic complications. New mode ignores description. Returns editable text without starting a call.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"numberId",
"direction",
"revision",
"mode",
"callMode"
],
"properties": {
"mode": {
"enum": [
"new",
"expand"
],
"type": "string"
},
"callMode": {
"enum": [
"bot",
"real"
],
"type": "string",
"default": "bot"
},
"numberId": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 4000,
"minLength": 1
},
"destination": {
"type": "string",
"maxLength": 40
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"description"
],
"properties": {
"description": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Run one isolated synthetic conversation against the active agent settings at the supplied revision. Outbound supports preset or custom fictional scenarios; inbound requires custom_scenario or scenario_description. Uses LiveKit test rooms and may consume AI usage. Never dials a phone number, publishes settings or invokes connected external tools.
| Parameter | Type | Description |
|---|---|---|
| revision * | integer | |
| scenario * | string | one of ["delivery","reservation","copay","custom"] |
| direction * | string | one of ["outbound","inbound"] |
| number_id * | string | |
| request_id * | string | |
| custom_scenario | object | |
| responder_outcome | string | An outcome ID from list_test_scenarios, or custom fictional facts for the responder. Omit to use the first outcome. |
| scenario_description | string |
Read a synthetic test’s status, transcript, result and transcript expiry.
| Parameter | Type | Description |
|---|---|---|
| test_id * | string |
{
"name": "get_agent_test",
"description": "Read a synthetic test’s status, transcript, result and transcript expiry.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"test_id"
],
"properties": {
"test_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"state",
"scenario",
"direction",
"revision",
"title",
"startedAt",
"createdAt",
"endedAt",
"transcriptExpired",
"transcript",
"result",
"simulatedMessage"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"state": {
"enum": [
"starting",
"running",
"completed",
"stopped",
"failed",
"timeout",
"interrupted"
],
"type": "string"
},
"title": {
"type": "string"
},
"result": {},
"endedAt": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"scenario": {
"enum": [
"delivery",
"reservation",
"copay",
"custom"
],
"type": "string"
},
"createdAt": {
"type": "string"
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"startedAt": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
},
"simulatedMessage": {},
"transcriptExpired": {
"type": "boolean"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get a short-lived, subscribe-only LiveKit credential for listening to your running synthetic test from a compatible client.
| Parameter | Type | Description |
|---|---|---|
| test_id * | string |
{
"name": "get_agent_test_listener",
"description": "Get a short-lived, subscribe-only LiveKit credential for listening to your running synthetic test from a compatible client.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"test_id"
],
"properties": {
"test_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"url",
"token"
],
"properties": {
"url": {
"type": "string"
},
"token": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Stop your synthetic test and retain its captured result.
| Parameter | Type | Description |
|---|---|---|
| test_id * | string |
{
"name": "stop_agent_test",
"description": "Stop your synthetic test and retain its captured result.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"test_id"
],
"properties": {
"test_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Read private diagnostic events for an owned call. Public call visibility never grants access to diagnostics.
| Parameter | Type | Description |
|---|---|---|
| limit * | integer | |
| cursor * | string | |
| call_id * | string |
{
"name": "get_call_diagnostics",
"description": "Read private diagnostic events for an owned call. Public call visibility never grants access to diagnostics.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"call_id",
"cursor",
"limit"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1
},
"cursor": {
"type": "string",
"default": "0",
"pattern": "^\\d{1,18}$"
},
"call_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get a short-lived, subscribe-only LiveKit credential for listening to your active call from a compatible client.
| Parameter | Type | Description |
|---|---|---|
| call_id * | string |
{
"name": "get_call_listener",
"description": "Get a short-lived, subscribe-only LiveKit credential for listening to your active call from a compatible client.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"call_id"
],
"properties": {
"call_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Recover an interrupted number claim or subscription attempt owned by this account and the original authorization grant. Requires that operation's original permissions. May reconcile number provisioning or retry the persisted subscription request with its original idempotency key. Never creates a replacement request or authorizes new spending. Completed results and definitive failures are returned without repeating provider actions.
| Parameter | Type | Description |
|---|---|---|
| operation_id * | string |
{
"name": "resume_operation",
"description": "Recover an interrupted number claim or subscription attempt owned by this account and the original authorization grant. Requires that operation's original permissions. May reconcile number provisioning or retry the persisted subscription request with its original idempotency key. Never creates a replacement request or authorizes new spending. Completed results and definitive failures are returned without repeating provider actions.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"operation_id"
],
"properties": {
"operation_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Recover a request’s durable outcome. A running/needs_attention operation must not be retried under a new ID.
| Parameter | Type | Description |
|---|---|---|
| operation_id * | string |
{
"name": "get_operation",
"description": "Recover a request’s durable outcome. A running/needs_attention operation must not be retried under a new ID.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"operation_id"
],
"properties": {
"operation_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read plans, usage, subscription state, payment-method summary and invoices. Reconciles subscription state with Stripe; use invoice_cursor for older invoices.
| Parameter | Type | Description |
|---|---|---|
| invoice_cursor | string |
{
"name": "get_billing",
"description": "Read plans, usage, subscription state, payment-method summary and invoices. Reconciles subscription state with Stripe; use invoice_cursor for older invoices.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"invoice_cursor": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"plan",
"plans",
"entitlement",
"subscription",
"has_saved_payment_method",
"payment_method",
"invoices",
"next_cursor",
"available"
],
"properties": {
"plan": {
"enum": [
"free",
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
"plans": {
"type": "array",
"items": {
"type": "object",
"required": [
"plan",
"name",
"priceCents",
"usageUnits"
],
"properties": {
"name": {
"type": "string"
},
"plan": {
"enum": [
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
"priceCents": {
"type": "number"
},
"usageUnits": {
"type": "number"
}
},
"additionalProperties": false
}
},
"invoices": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"status",
"amount_due",
"amount_paid",
"currency",
"url",
"pdf"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"pdf": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"currency": {
"type": "string"
},
"amount_due": {
"type": "number"
},
"amount_paid": {
"type": "number"
}
},
"additionalProperties": false
}
},
"available": {
"type": "boolean"
},
"entitlement": {
"type": "object",
"required": [
"plan",
"planName",
"freeCalls",
"freeCallsUsed",
"freeCallsLeft",
"usageIncluded",
"usageUsed",
"usageLeft",
"usageLeftPct",
"period",
"nextPlan",
"planChangesAt",
"maxMinutesPerCall",
"callBlocked"
],
"properties": {
"plan": {
"enum": [
"free",
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
"period": {
"anyOf": [
{
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"end": {
"type": "string"
},
"start": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextPlan": {
"anyOf": [
{
"enum": [
"free",
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
{
"type": "null"
}
]
},
"planName": {
"type": "string"
},
"freeCalls": {
"type": "number"
},
"usageLeft": {
"type": "number"
},
"usageUsed": {
"type": "number"
},
"callBlocked": {
"type": [
"string",
"null"
]
},
"usageLeftPct": {
"type": "number"
},
"freeCallsLeft": {
"type": "number"
},
"freeCallsUsed": {
"type": "number"
},
"planChangesAt": {
"type": [
"string",
"null"
]
},
"usageIncluded": {
"type": "number"
},
"maxMinutesPerCall": {
"type": "number"
}
},
"additionalProperties": false
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"operation_id": {
"type": "string"
},
"subscription": {
"type": "object",
"required": [
"status",
"cancel_at_period_end",
"change"
],
"properties": {
"change": {
"anyOf": [
{
"type": "object",
"required": [
"plan",
"at"
],
"properties": {
"at": {
"type": "string"
},
"plan": {
"enum": [
"free",
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"status": {
"type": [
"string",
"null"
]
},
"cancel_at_period_end": {
"type": "boolean"
}
},
"additionalProperties": false
},
"payment_method": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"type": {
"type": "string"
},
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"has_saved_payment_method": {
"type": "boolean"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Create a 15-minute quote for starting a subscription, changing its plan, canceling renewal at period end, or undoing cancellation/a scheduled downgrade. Returns immediate charges, monthly list price, effective time and allowances. May read Stripe and save a local quote; does not charge or change a subscription. Show the complete quote to the user and obtain explicit approval before execute_subscription_change. Each preview creates a new quote.
| Parameter | Type | Description |
|---|---|---|
| plan | string | one of ["starter","pro","pro_starter","pro_plus","pro_max"] |
| trial | boolean | |
| action * | string | one of ["subscribe","change","cancel","resume"] |
| promotion_code | string |
{
"name": "preview_subscription_change",
"description": "Create a 15-minute quote for starting a subscription, changing its plan, canceling renewal at period end, or undoing cancellation/a scheduled downgrade. Returns immediate charges, monthly list price, effective time and allowances. May read Stripe and save a local quote; does not charge or change a subscription. Show the complete quote to the user and obtain explicit approval before execute_subscription_change. Each preview creates a new quote.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"plan": {
"enum": [
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
"trial": {
"type": "boolean"
},
"action": {
"enum": [
"subscribe",
"change",
"cancel",
"resume"
],
"type": "string"
},
"promotion_code": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"quote_id",
"action",
"plan",
"amount_due",
"currency",
"amount_is_estimate",
"trial_days",
"promotion_code",
"recurring_amount",
"recurring_amount_basis",
"effective_at",
"number_limit",
"proration_date",
"requires_user_authorization",
"expires_in_seconds",
"next_action"
],
"properties": {
"plan": {
"anyOf": [
{
"enum": [
"starter",
"pro",
"pro_starter",
"pro_plus",
"pro_max"
],
"type": "string"
},
{
"type": "null"
}
]
},
"action": {
"enum": [
"subscribe",
"change",
"cancel",
"resume"
],
"type": "string"
},
"currency": {
"type": "string"
},
"quote_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"amount_due": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Amount due now in the currency's minor units."
},
"trial_days": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"next_action": {
"type": "string",
"const": "execute_subscription_change"
},
"effective_at": {
"type": [
"string",
"null"
]
},
"number_limit": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"operation_id": {
"type": "string"
},
"promotion_code": {
"type": [
"string",
"null"
]
},
"proration_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"recurring_amount": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Monthly list price in minor units, before discounts and tax."
},
"amount_is_estimate": {
"type": "boolean"
},
"expires_in_seconds": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"recurring_amount_basis": {
"type": "string",
"const": "monthly_list_price_before_discounts_and_tax"
},
"requires_user_authorization": {
"type": "boolean",
"const": true
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Apply the exact, unexpired quote the user explicitly approved after seeing its immediate charges, recurring price, effective time and limits. May charge a saved payment method, change the subscription, cancel renewal or undo a scheduled change. Set user_authorized=true only after that approval; never infer permission to spend. Reuse the same request_id and arguments after a lost response. Return any payment/authentication URL for the user to complete; never collect payment credentials in chat.
| Parameter | Type | Description |
|---|---|---|
| quote_id * | string | |
| request_id * | string | |
| user_authorized * | boolean | The user explicitly approved this quote's charges and terms. Never infer approval from a request to preview. |
{
"name": "execute_subscription_change",
"description": "Apply the exact, unexpired quote the user explicitly approved after seeing its immediate charges, recurring price, effective time and limits. May charge a saved payment method, change the subscription, cancel renewal or undo a scheduled change. Set user_authorized=true only after that approval; never infer permission to spend. Reuse the same request_id and arguments after a lost response. Return any payment/authentication URL for the user to complete; never collect payment credentials in chat.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"quote_id",
"user_authorized",
"request_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"user_authorized": {
"type": "boolean",
"const": true,
"description": "The user explicitly approved this quote's charges and terms. Never infer approval from a request to preview."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"status",
"url",
"next_action"
],
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"next_action": {
"type": "string",
"const": "get_billing"
},
"operation_id": {
"type": "string"
},
"payment_flow": {
"type": "string",
"const": "stripe_checkout"
},
"agent_payment_support": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Update the Stripe customer’s billing name, email or address. Payment credentials are never accepted here.
| Parameter | Type | Description |
|---|---|---|
| changes * | object | |
| request_id * | string |
{
"name": "update_billing_profile",
"description": "Update the Stripe customer’s billing name, email or address. Payment credentials are never accepted here.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"request_id",
"changes"
],
"properties": {
"changes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 100
},
"line1": {
"type": "string",
"maxLength": 200
},
"line2": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 100
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"postal_code": {
"type": "string",
"maxLength": 20
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Create a Stripe-hosted billing portal link for this account's existing Stripe customer. Creating the link does not charge, change or cancel a subscription; the user chooses and confirms any billing changes on Stripe. Returns to Patch's fixed billing page. Reuse request_id after a lost response. Never request or accept card details in chat.
| Parameter | Type | Description |
|---|---|---|
| request_id * | string |
{
"name": "create_billing_portal",
"description": "Create a Stripe-hosted billing portal link for this account's existing Stripe customer. Creating the link does not charge, change or cancel a subscription; the user chooses and confirms any billing changes on Stripe. Returns to Patch's fixed billing page. Reuse request_id after a lost response. Never request or accept card details in chat.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"request_id"
],
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Start with get_capabilities for account management and permissions. Patch MCP lets you place real phone calls from the selected outbound number, using the default number when number_id is omitted. If place_call returns caller_id_not_verified, share verification_url and ask the user to complete caller ID verification there, then retry their call. Never collect verification codes in chat. Use get_phone_number without number_id for the default outbound caller ID; it returns phone_number in E.164 format and caller_id_status. With the phone workspace enabled, list_phone_numbers lists available sources and a verify_number_url for adding personal lines; pass number_id to place_call to choose an enabled, published outbound number. Use place_call with a precise objective (include names, dates, times, quantities and acceptable fallbacks). Supply the optional callee local IANA timezone in timezone when known from reliable context (for example America/Chicago). If omitted, Patch uses phone-prefix timezone metadata when it identifies one zone, otherwise America/Chicago. Phone metadata can be inaccurate for moved or ported numbers. If the client supports MCP Events webhooks, subscribe to call.resolved for the final result (call.completed reports hangup earlier). Otherwise poll get_call with wait_seconds until the status is terminal and read the resolution. Calls use the optional place_call.locale (for example en-US, es-MX, pt-BR, fr, it, ru, pl, uk, ro, nl, de), otherwise the selected source’s published language in the phone workspace, then the supported account locale or en-US. The objective and context may use another language. The resolved locale, language and voice are returned by place_call and get_call. The locale applies only to that call; the call starts in the selected language and switches if the callee asks for or prefers another. Calling supports Central America, Europe, North America, and South America, subject to route availability. place_call checks route availability and returns an estimated one-minute provider cost when a call is placed. Free calls require both the connected caller ID and destination to be US/Canadian; calls involving any other number require a paid plan from the first call. Calls are private by default. Use set_call_visibility only when the user explicitly asks to publish or make a call private; public calls have permanent token-free links accessible to anyone while public. Always offer the listen_url to the user. Never place calls to emergency services, and relay policy rejections to the user instead of retrying. The default opening says who the voice agent is calling for and states the call's purpose. Use get_agent and update_agent for active number settings and inbound greeting/instructions. Patch internal system prompts and outbound greeting/instructions are not exposed through MCP; use place_call objective and context for call-specific facts. Changes apply directly to new calls. Call facts are added automatically. The recording disclosure belongs in the first spoken turn that advances the objective, whether asking a question, making a request, or giving task-related details. Brief introductory chatter or an acknowledgment of a request to hold may come first. Naturally include “on a recorded line” in the introduction or response, using a natural equivalent in the selected call language. There is no separate opening or agent_instructions argument on place_call. If place_call fails with user_name_required, ask your user what name to give and call again with it in user_name — it is stored on the account for future calls. Calls can go out at any time of day, any day of the week; the user is responsible for fair use. Call availability and duration depend on the connected account entitlement. Usage estimates are rechecked before dialing. When a call is unavailable, explain the returned reason, remaining allowance and reset time without repeated retries. If the call response includes upgrade_url, share that l
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
| string |
| Destination phone number in E.164, e.g. +14155551234. Supported: Central America, Europe, North America, and South America (Telnyx regions; Caribbean excluded). Destination country codes: BZ, CR, SV, GT, HN, NI, PA, AX, AL, AD, AT, BE, BA, BG, HR, CY, CZ, DK, EE, FO, FI, FR, DE, GI, GR, GL, GG, HU, … |
| locale | string | Language the voice agent should open the call in. Choose one of the advertised BCP 47 tags for the active speech provider. The objective and context may be written in another language. Defaults to the selected source’s published preference in the phone workspace, otherwise the supported account pref… |
| context | string | Extra facts the agent may reveal if asked (e.g. party preferences, callback number policy). |
| timezone | string | Optional callee local IANA timezone, for example America/Chicago or Europe/London. Supply it when known from reliable context. If omitted, Patch uses phone-prefix timezone metadata when it identifies one zone, otherwise America/Chicago. Phone metadata can be inaccurate for moved or ported numbers. |
| number_id | string | Account phone assignment ID from list_phone_numbers; omit to use the account default. |
| objective * | string | What the call should achieve, with all needed specifics and acceptable fallbacks. E.g. "Book a table for 2 tonight at 19:30 under 'Iddo'. Acceptable window 19:00–20:30." |
| user_name | string | The user name supplied to the voice agent for the call, e.g. "Sam" or "Sam at Acme". The default introduction uses the saved name when explaining who the call is for; a custom introduction follows the published outbound agent instructions. Only needed when place_call returned user_name_required: ask… |
| request_id | string | Optional retry key. Reuse the same UUID and arguments after a lost response to avoid a second call. |
| callee_name | string | Who is being called, e.g. "Zuni Café". Improves the conversation and the logs. |
{
"name": "place_call",
"description": "Place one real phone call FROM the selected outbound number (the authenticated user’s verified personal number by default) to accomplish a specific objective (book a table, ask a question, chase an order). A real-time voice agent handles the call, including automated phone menus and hold queues. Its default opening says who it is calling for and states the call's purpose. Use get_agent and update_agent for number settings and inbound greeting/instructions. Outbound greeting and system instructions are read-only through MCP; use objective and context for call-specific facts. Changes apply directly to new calls. Call facts are added automatically. The recording disclosure belongs in the first spoken turn that advances the objective, whether asking a question, making a request, or giving task-related details. Brief introductory chatter or an acknowledgment of a request to hold may come first. Naturally include “on a recorded line” in the introduction or response, using a natural equivalent in the selected call language. Returns immediately with a call_id and resolved locale, language, and voice; the call proceeds in the background and typically takes 2–5 minutes — poll get_call (pass wait_seconds to long-poll) until the status is terminal. The response includes a listen_url: a private web link where the user can hear the call live, watch the transcript, and stop the call — offer it to the user. Calls in Central America, Europe, North America, and South America, subject to route availability; never for emergencies. Calls involving a non-US/Canadian number require a paid plan from the first call. Rates vary by caller ID and destination; the response includes an estimated provider cost for one minute, including per-call costs. This estimate is not a final charge. Paid usage follows telephone, AI and any lookup costs, including unsuccessful attempts, and can update after the call. Calls can be placed at any time of day, any day of the week, and the user is responsible for fair use; one call runs at a time per account and volume is governed by the plan — rejections return a machine-readable `error` code with retry guidance, so relay the message to the user rather than retrying blindly. The voice agent receives the name of the person the call is for: if the account has no name on file the call is rejected with `user_name_required` — ask your user what name to give (e.g. \"Sam\" or \"Sam at Acme\"), then call again with it in `user_name`; it is saved to the account for future calls.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"to",
"objective"
],
"properties": {
"to": {
"type": "string",
"description": "Destination phone number in E.164, e.g. +14155551234. Supported: Central America, Europe, North America, and South America (Telnyx regions; Caribbean excluded). Destination country codes: BZ, CR, SV, GT, HN, NI, PA, AX, AL, AD, AT, BE, BA, BG, HR, CY, CZ, DK, EE, FO, FI, FR, DE, GI, GR, GL, GG, HU, IS, IE, IM, IT, JE, LV, LI, LT, LU, MK, MT, MC, ME, NL, NO, PL, PT, XK, RO, RU, SM, RS, SK, SI, ES, SJ, SE, CH, UA, GB, VA, US, CA, MX, PM, AR, BO, BR, CL, CO, EC, FK, GF, GY, PY, PE, SR, UY, VE."
},
"locale": {
"enum": [
"en-US",
"es-MX",
"pt-BR",
"fr",
"it",
"ru",
"pl",
"ro",
"nl",
"de"
],
"type": "string",
"description": "Language the voice agent should open the call in. Choose one of the advertised BCP 47 tags for the active speech provider. The objective and context may be written in another language. Defaults to the selected source’s published preference in the phone workspace, otherwise the supported account preference, then English. Uses an available saved voice or the provider default. Applies only to this call; the call starts in the selected language and switches if the callee asks for or prefers another. Unsupported locales return unsupported_language before dialing"
},
"context": {
"type": "string",
"maxLength": 2000,
"description": "Extra facts the agent may reveal if asked (e.g. party preferences, callback number policy)."
},
"timezone": {
"type": "string",
"description": "Optional callee local IANA timezone, for example America/Chicago or Europe/London. Supply it when known from reliable context. If omitted, Patch uses phone-prefix timezone metadata when it identifies one zone, otherwise America/Chicago. Phone metadata can be inaccurate for moved or ported numbers."
},
"number_id": {
"type": "string",
"description": "Account phone assignment ID from list_phone_numbers; omit to use the account default."
},
"objective": {
"type": "string",
"maxLength": 2000,
"minLength": 10,
"description": "What the call should achieve, with all needed specifics and acceptable fallbacks. E.g. \"Book a table for 2 tonight at 19:30 under 'Iddo'. Acceptable window 19:00–20:30.\""
},
"user_name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The user name supplied to the voice agent for the call, e.g. \"Sam\" or \"Sam at Acme\". The default introduction uses the saved name when explaining who the call is for; a custom introduction follows the published outbound agent instructions. Only needed when place_call returned user_name_required: ask your user for it, do not invent one. Saved to the account for future calls; a later value updates the saved name."
},
"request_id": {
"type": "string",
"format": "uuid",
"description": "Optional retry key. Reuse the same UUID and arguments after a lost response to avoid a second call."
},
"callee_name": {
"type": "string",
"maxLength": 200,
"description": "Who is being called, e.g. \"Zuni Café\". Improves the conversation and the logs."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"call_id",
"status",
"to",
"from",
"callee_name",
"language",
"locale",
"voice",
"max_duration_minutes",
"created_at",
"listen_url",
"message",
"pricing",
"number_id"
],
"properties": {
"to": {
"type": "string",
"description": "Destination in E.164 format."
},
"from": {
"type": "string",
"description": "Caller ID in E.164 format."
},
"voice": {
"anyOf": [
{
"type": "string",
"description": "Resolved voice identifier."
},
{
"type": "null"
}
]
},
"locale": {
"type": "string",
"description": "Resolved BCP 47 language/locale for this call."
},
"status": {
"enum": [
"queued",
"ringing",
"in_progress",
"completed",
"answered_silently",
"no_answer",
"busy",
"voicemail",
"failed",
"rejected",
"canceled",
"declined_recording",
"opted_out"
],
"type": "string",
"description": "Current call lifecycle state."
},
"call_id": {
"type": "string",
"description": "Call identifier used with get_call, end_call and set_call_visibility."
},
"message": {
"type": "string",
"description": "Polling and allowance guidance."
},
"pricing": {
"type": "object",
"required": [
"currency",
"estimated_total_cents_at_one_minute",
"estimated_telnyx_cents_at_one_minute"
],
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"reserved_usage_units": {
"anyOf": [
{
"type": "number",
"description": "Usage units reserved for the call."
},
{
"type": "null"
}
]
},
"estimated_total_cents_at_one_minute": {
"type": "string",
"description": "Estimated provider cost for a one-minute call, including per-call costs; not a final charge."
},
"estimated_telnyx_cents_at_one_minute": {
"anyOf": [
{
"type": "string",
"description": "Estimated carrier cost for one minute; null when included in a combined service estimate."
},
{
"type": "null"
}
]
}
},
"additionalProperties": {}
},
"language": {
"type": "string",
"description": "Resolved call language."
},
"number_id": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"description": "ISO 8601 creation time."
},
"listen_url": {
"type": "string",
"description": "URL for the user to listen, read the transcript and stop an active call."
},
"callee_name": {
"anyOf": [
{
"type": "string",
"description": "Recipient display name."
},
{
"type": "null"
}
]
},
"max_duration_minutes": {
"anyOf": [
{
"type": "number",
"description": "Free-call duration cap; null for paid calls."
},
{
"type": "null"
}
]
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Machine-readable failure code."
},
"message": {
"type": "string",
"description": "Explanation or recovery guidance."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Successful result or a machine-readable tool error."
},
"annotations": {
"title": "Place call",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}{
"name": "get_call",
"description": "Get the status and, once terminal, the structured resolution of a call started with place_call. Returns instantly by default. Pass wait_seconds (max 50) to have the server hold the request and return early on any status change — fewer round trips while a call is in progress. Terminal statuses: completed, answered_silently, no_answer, busy, voicemail, failed, rejected, canceled, declined_recording, opted_out. rejected means safety screening declined the objective before dialing; error.message and resolution.summary explain why. Terminal calls include a `resolution` {outcome: achieved|partially_achieved|not_achieved|no_conversation|unknown, summary, commitments[], follow_ups[], key_facts[]} — read it before the transcript; it is the answer. unknown means the outcome could not be determined; review the transcript. Completed calls also carry the transcript (may be marked transcript_truncated) and a recording_url the user can listen to (private links expire after ~1 hour; on staging, fetch with the same OAuth Authorization: Bearer header). The resolution can lag the terminal status by a few seconds while it is extracted. Calls include the resolved locale, language, voice, and is_public; public calls return token-free listen and recording URLs that remain accessible while public. Use set_call_visibility only when the user explicitly asks to publish or make private. Every call includes a listen_url — the call page for the user (live audio + transcript while in progress; recording + transcript once ended). ended_by='user' on a canceled call means the user deliberately stopped it from that page — don't retry. recording_status=processing means the LiveKit session recording is being finalized and copied to private storage separately from the result. A recording can fail or be unavailable. Call get_call again, or pass wait_seconds on an already-terminal call to wait for a recording state change.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"call_id"
],
"properties": {
"call_id": {
"type": "string",
"description": "The id returned by place_call."
},
"wait_seconds": {
"type": "integer",
"maximum": 50,
"minimum": 0,
"description": "0 (default) = instant status check. Up to 50 = server-side long-poll."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"call_id",
"status",
"to",
"callee_name",
"language",
"locale",
"voice",
"amd_result",
"duration_seconds",
"is_public",
"listen_url",
"resolution",
"transcript",
"recording_url",
"recording_status",
"costs",
"error",
"created_at",
"ended_at",
"number_id"
],
"properties": {
"to": {
"type": "string",
"description": "Destination in E.164 format."
},
"costs": {
"type": "object",
"required": [
"currency"
],
"properties": {
"currency": {
"type": "string",
"const": "USD"
},
"reserved_usage_units": {
"anyOf": [
{
"type": "number",
"description": "Reserved usage units; absent on legacy calls."
},
{
"type": "null"
}
]
}
},
"additionalProperties": {}
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Call failure code."
},
"message": {
"type": "string",
"description": "Call failure explanation."
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"type": "string",
"description": "Resolved voice identifier."
},
{
"type": "null"
}
]
},
"locale": {
"type": "string",
"description": "Resolved BCP 47 language/locale for this call."
},
"status": {
"enum": [
"queued",
"ringing",
"in_progress",
"completed",
"answered_silently",
"no_answer",
"busy",
"voicemail",
"failed",
"rejected",
"canceled",
"declined_recording",
"opted_out"
],
"type": "string",
"description": "Current call lifecycle state."
},
"call_id": {
"type": "string",
"description": "Call identifier used with get_call, end_call and set_call_visibility."
},
"ended_at": {
"anyOf": [
{
"type": "string",
"description": "ISO 8601 end time; null while active."
},
{
"type": "null"
}
]
},
"ended_by": {
"type": "string",
"description": "Party or system that ended the call."
},
"language": {
"type": "string",
"description": "Resolved call language."
},
"is_public": {
"type": "boolean",
"description": "Whether the call has a public link."
},
"number_id": {
"type": [
"string",
"null"
]
},
"amd_result": {
"anyOf": [
{
"type": "string",
"description": "Answering-machine detection result."
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"description": "ISO 8601 creation time."
},
"end_reason": {
"type": "string",
"description": "Reason the call ended."
},
"listen_url": {
"type": "string",
"description": "URL for the user to listen, read the transcript and stop an active call."
},
"resolution": {
"anyOf": [
{
"type": "object",
"required": [
"outcome",
"summary",
"commitments",
"follow_ups",
"key_facts",
"callee_requested_no_further_calls"
],
"properties": {
"outcome": {
"enum": [
"achieved",
"partially_achieved",
"not_achieved",
"no_conversation",
"unknown"
],
"type": "string",
"description": "Whether the call objective was met; unknown when review is unavailable or evidence is insufficient."
},
"summary": {
"type": "string",
"description": "User-facing summary of what happened."
},
"key_facts": {
"type": "array",
"items": {
"type": "string",
"description": "Fact learned."
},
"description": "Useful information from the conversation."
},
"follow_ups": {
"type": "array",
"items": {
"type": "string",
"description": "Next action."
},
"description": "Actions the user still needs to take."
},
"commitments": {
"type": "array",
"items": {
"type": "string",
"description": "Confirmed commitment."
},
"description": "What the callee agreed to."
},
"callee_requested_no_further_calls": {
"type": "boolean",
"description": "Whether the recipient asked not to be called again."
}
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"transcript": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"text",
"at_ms"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"callee",
"agent",
"keypad",
"music"
],
"type": "string",
"description": "Speaker, confirmed keypad action, or music heard on the line (not speech)."
},
"text": {
"type": "string",
"description": "Transcript text."
},
"at_ms": {
"type": "number",
"description": "Milliseconds from the transcript timeline origin."
},
"sequence": {
"type": "number"
},
"duration_ms": {
"anyOf": [
{
"type": "number",
"description": "Music rows only: how long the music played; null while it is still playing."
},
{
"type": "null"
}
]
}
},
"additionalProperties": {}
},
"description": "Conversation entries; empty before speech is available."
},
"callee_name": {
"anyOf": [
{
"type": "string",
"description": "Recipient display name."
},
{
"type": "null"
}
]
},
"recording_url": {
"anyOf": [
{
"type": "string",
"description": "Audio URL when ready; private URLs expire."
},
{
"type": "null"
}
]
},
"duration_seconds": {
"type": "number",
"description": "Connected duration in seconds."
},
"recording_status": {
"enum": [
"none",
"processing",
"available",
"failed"
],
"type": "string",
"description": "Recording availability."
},
"transcript_truncated": {
"type": "boolean",
"description": "Whether earlier transcript content was omitted."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Machine-readable failure code."
},
"message": {
"type": "string",
"description": "Explanation or recovery guidance."
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Successful result or a machine-readable tool error."
},
"annotations": {
"title": "Get call",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}{
"name": "start_agent_test",
"description": "Run one isolated synthetic conversation against the active agent settings at the supplied revision. Outbound supports preset or custom fictional scenarios; inbound requires custom_scenario or scenario_description. Uses LiveKit test rooms and may consume AI usage. Never dials a phone number, publishes settings or invokes connected external tools.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number_id",
"revision",
"scenario",
"direction",
"request_id"
],
"properties": {
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"scenario": {
"enum": [
"delivery",
"reservation",
"copay",
"custom"
],
"type": "string"
},
"direction": {
"enum": [
"outbound",
"inbound"
],
"type": "string",
"default": "outbound"
},
"number_id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"custom_scenario": {
"type": "object",
"required": [
"title",
"objective",
"facts",
"greeting",
"timeZone"
],
"properties": {
"facts": {
"type": "string",
"maxLength": 4000,
"minLength": 10
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"greeting": {
"type": "string",
"default": "",
"maxLength": 500
},
"timeZone": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"objective": {
"type": "string",
"maxLength": 2000,
"minLength": 10
}
},
"additionalProperties": false
},
"responder_outcome": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "An outcome ID from list_test_scenarios, or custom fictional facts for the responder. Omit to use the first outcome."
},
"scenario_description": {
"type": "string",
"maxLength": 4000,
"minLength": 10
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"state",
"scenario",
"direction",
"revision",
"title",
"startedAt",
"createdAt",
"endedAt",
"transcriptExpired",
"transcript",
"result",
"simulatedMessage"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"state": {
"enum": [
"starting",
"running",
"completed",
"stopped",
"failed",
"timeout",
"interrupted"
],
"type": "string"
},
"title": {
"type": "string"
},
"result": {},
"endedAt": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"scenario": {
"enum": [
"delivery",
"reservation",
"copay",
"custom"
],
"type": "string"
},
"createdAt": {
"type": "string"
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"startedAt": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"operation_id": {
"type": "string"
},
"simulatedMessage": {},
"transcriptExpired": {
"type": "boolean"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
},
{
"type": "object",
"required": [
"operation_id",
"status"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"next_action": {
"type": "string"
},
"operation_id": {
"type": "string"
}
},
"additionalProperties": {}
}
],
"$schema": "http://json-schema.org/draft-07/schema#"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}