{ "openapi": "3.0.3", "info": { "title": "ThunderPhone API", "version": "1.0.0", "description": "Programmatic access to the ThunderPhone platform — agents, phone numbers, calls, billing, webhooks, and more. See https://docs.thunderphone.com for the hosted reference, tutorials and migration guides." }, "paths": { "/v1/healthz": { "get": { "operationId": "healthz_retrieve", "tags": [ "healthz" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/status/heartbeat": { "get": { "operationId": "status_heartbeat_retrieve", "description": "Sanitized per-product heartbeat verdicts for the public status page.\n\nServes the latest ``HeartbeatResult`` per product family. Deliberately\ncarries no org ids, call ids, provider names, or failure internals — the\nstatus dashboard is public and must not name subprocessors.", "tags": [ "status" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/monitoring/azure-alert": { "post": { "operationId": "monitoring_azure_alert_create", "description": "Receiver for Azure Monitor action-group webhooks → Slack relay.\n\nAuth is the shared token in the query string (the URL, token included,\nlives inside the action-group receiver config). Always answers 200 once\nthe token checks out so Azure does not retry-storm on Slack hiccups.", "tags": [ "monitoring" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/monitoring/glitchtip-alert": { "post": { "operationId": "monitoring_glitchtip_alert_create", "description": "Receiver for informational GlitchTip issue alerts → Slack only.", "tags": [ "monitoring" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/monitoring/ack/{token}": { "get": { "operationId": "monitoring_ack_retrieve", "description": "One-tap acknowledgement link for a Sev-0 page (opened from Slack).\n\nUnauthenticated by design — the unguessable per-incident token is the\ncredential, so the on-call can ack from a phone without a login dance.", "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "required": true } ], "tags": [ "monitoring" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/monitoring/auto-ack": { "post": { "operationId": "monitoring_auto_ack_create", "description": "Bulk acknowledgement for automated responders (the incident watcher).\n\nAuth is the same shared query-string token as the alert webhook — the\nwatcher reads it off the action group's receiver config with its managed\nidentity, so no new secret exists anywhere. Acks by rule name because the\nwatcher knows which rule it spawned a triage session for, never which\nAlertIncident row the relay opened.", "tags": [ "monitoring" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices": { "get": { "operationId": "voices_retrieve", "description": "Return the list of available voices and languages.\n\nGET /v1/voices\nGET /v1/voices?languages=en,es (filter to voices supporting ALL listed languages)\nGET /v1/voices?category=multilingual (filter by category)\nGET /v1/voices?gender=female (filter by gender)\n\nResponse format:\n{\n \"voices\": [...],\n \"languages\": [...]\n}", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/policy": { "get": { "operationId": "voices_policy_retrieve", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/preview": { "post": { "operationId": "voices_preview_create", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/previews/{public_id}": { "get": { "operationId": "voices_previews_retrieve", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "voices" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/clones": { "get": { "operationId": "voices_clones_retrieve", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "voices_clones_create", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/clones/{public_id}": { "get": { "operationId": "voices_clones_retrieve_2", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "voices_clones_partial_update", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "voices_clones_destroy", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/voices/clones/{public_id}/preview": { "get": { "operationId": "voices_clones_preview_retrieve", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "voices" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/quota-requests": { "post": { "operationId": "voices_quota_requests_create", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voices/quota-requests/current": { "get": { "operationId": "voices_quota_requests_current_retrieve", "tags": [ "voices" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/orgs/": { "get": { "operationId": "orgs_list", "tags": [ "orgs" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserOrg" } } } }, "description": "" } } }, "post": { "operationId": "orgs_create", "tags": [ "orgs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } } }, "/v1/orgs/{id}/": { "put": { "operationId": "orgs_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "orgs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } }, "delete": { "operationId": "orgs_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "orgs" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } }, "patch": { "operationId": "orgs_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "orgs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } }, "get": { "operationId": "orgs_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "orgs" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOrg" } } }, "description": "" } } } }, "/v1/outbound-tcpa-confirmation": { "get": { "operationId": "outbound_tcpa_confirmation_retrieve", "description": "Read or record the organization's outbound TCPA confirmation.", "tags": [ "outbound-tcpa-confirmation" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "outbound_tcpa_confirmation_create", "description": "Read or record the organization's outbound TCPA confirmation.", "tags": [ "outbound-tcpa-confirmation" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/live-processing-disclosure-disable-attestation": { "get": { "operationId": "live_processing_disclosure_disable_attestation_retrieve", "description": "Canonical package and one-time org attestation endpoint.", "tags": [ "live-processing-disclosure-disable-attestation" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "live_processing_disclosure_disable_attestation_create", "description": "Canonical package and one-time org attestation endpoint.", "tags": [ "live-processing-disclosure-disable-attestation" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/campaigns": { "get": { "operationId": "campaigns_retrieve", "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "campaigns_create", "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/campaigns/{campaign_id}": { "get": { "operationId": "campaigns_retrieve_2", "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "campaigns_partial_update", "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "campaigns_destroy", "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/campaigns/{campaign_id}/contacts": { "post": { "operationId": "campaigns_contacts_create", "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/campaigns/{campaign_id}/stats": { "get": { "operationId": "campaigns_stats_retrieve", "parameters": [ { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/campaigns/{campaign_id}/{action}": { "post": { "operationId": "campaigns_create_2", "parameters": [ { "in": "path", "name": "action", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "campaign_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "campaigns" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents": { "get": { "operationId": "agents_list", "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agent" } } } }, "description": "" } } }, "post": { "operationId": "agents_create", "tags": [ "agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AgentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AgentRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "description": "" } } } }, "/v1/agents/prompt-language-check": { "post": { "operationId": "agents_prompt_language_check_create", "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/translate-prompt": { "post": { "operationId": "agents_translate_prompt_create", "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/generate-acknowledgement-prompt": { "post": { "operationId": "agents_generate_acknowledgement_prompt_create", "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}": { "get": { "operationId": "agents_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "description": "" } } }, "put": { "operationId": "agents_update", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AgentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AgentRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "description": "" } } }, "patch": { "operationId": "agents_partial_update", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAgentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAgentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAgentRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "description": "" } } }, "delete": { "operationId": "agents_destroy", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/deploy": { "post": { "operationId": "agents_deploy_create", "description": "POST /v1/agents//deploy — promote draft to deployed.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/discard-draft": { "post": { "operationId": "agents_discard_draft_create", "description": "POST /v1/agents//discard-draft — clear all draft fields.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/duplicate": { "post": { "operationId": "agents_duplicate_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/transfer": { "post": { "operationId": "agents_transfer_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/versions": { "get": { "operationId": "agents_versions_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agent-imports": { "get": { "operationId": "agent_imports_retrieve", "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "agent_imports_create", "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agent-imports/{public_id}": { "get": { "operationId": "agent_imports_retrieve_2", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "agent_imports_destroy", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/agent-imports/{public_id}/commit": { "post": { "operationId": "agent_imports_commit_create", "parameters": [ { "in": "path", "name": "public_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agent-imports/{public_id}/items/{item_id}": { "patch": { "operationId": "agent_imports_items_partial_update", "parameters": [ { "in": "path", "name": "item_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "public_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "agent-imports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/consent-attestations": { "get": { "operationId": "agents_consent_attestations_retrieve", "description": "List or record announcement-disable attestations for one org-scoped agent.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "agents_consent_attestations_create", "description": "List or record announcement-disable attestations for one org-scoped agent.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-scenarios": { "get": { "operationId": "agents_test_scenarios_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "agents_test_scenarios_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-scenarios/generate": { "post": { "operationId": "agents_test_scenarios_generate_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-scenarios/refresh": { "post": { "operationId": "agents_test_scenarios_refresh_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-scenarios/{scenario_id}": { "get": { "operationId": "agents_test_scenarios_retrieve_2", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "scenario_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "agents_test_scenarios_partial_update", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "scenario_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "agents_test_scenarios_destroy", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "scenario_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/calls/{call_id}/promote-to-scenario": { "post": { "operationId": "calls_promote_to_scenario_create", "description": "Create one reusable regression scenario from a production call.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/validation-examples": { "post": { "operationId": "calls_validation_examples_create", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/validation-sets": { "get": { "operationId": "validation_sets_retrieve", "tags": [ "validation-sets" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/validation-examples": { "get": { "operationId": "validation_examples_retrieve", "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/validation-examples": { "get": { "operationId": "agents_validation_examples_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/validation-runs": { "get": { "operationId": "agents_validation_runs_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "agents_validation_runs_create", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/validation-status": { "get": { "operationId": "agents_validation_status_retrieve", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/validation-runs/{run_id}": { "get": { "operationId": "validation_runs_retrieve", "parameters": [ { "in": "path", "name": "run_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-runs" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/validation-examples/{example_id}": { "get": { "operationId": "validation_examples_retrieve_2", "parameters": [ { "in": "path", "name": "example_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "validation_examples_partial_update", "parameters": [ { "in": "path", "name": "example_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "validation_examples_destroy", "parameters": [ { "in": "path", "name": "example_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/validation-examples/{example_id}/audio/{span_index}": { "get": { "operationId": "validation_examples_audio_retrieve", "parameters": [ { "in": "path", "name": "example_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "span_index", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/validation-examples/{example_id}/replay": { "post": { "operationId": "validation_examples_replay_create", "parameters": [ { "in": "path", "name": "example_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "validation-examples" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-runs": { "get": { "operationId": "agents_test_runs_retrieve", "description": "GET /v1/agents//test-runs — list scenario batches for the agent.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-runs/execute": { "post": { "operationId": "agents_test_runs_execute_create", "description": "POST /v1/agents//test-runs/execute — kick off a batch of scenario runs.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/test-runs/{batch_id}": { "get": { "operationId": "agents_test_runs_retrieve_2", "description": "GET /v1/agents//test-runs/ — batch detail with per-scenario runs.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "batch_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/suites": { "get": { "operationId": "suites_retrieve", "tags": [ "suites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "suites_create", "tags": [ "suites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/suites/{suite_id}": { "get": { "operationId": "suites_retrieve_2", "parameters": [ { "in": "path", "name": "suite_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "suites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "suites_partial_update", "parameters": [ { "in": "path", "name": "suite_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "suites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "suites_destroy", "parameters": [ { "in": "path", "name": "suite_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "suites" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/integrations/{integration_id}": { "get": { "operationId": "integrations_retrieve_2", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } }, "description": "" } } }, "put": { "operationId": "integrations_update", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IntegrationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IntegrationRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } }, "description": "" } } }, "patch": { "operationId": "integrations_partial_update", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedIntegrationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedIntegrationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedIntegrationRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } }, "description": "" } } }, "delete": { "operationId": "integrations_destroy", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/phone-numbers/limits": { "get": { "operationId": "phone_numbers_limits_retrieve", "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/phone-numbers": { "get": { "operationId": "phone_numbers_list", "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } } } }, "description": "" } } }, "post": { "operationId": "phone_numbers_create", "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumber" } } }, "description": "" } } } }, "/v1/phone-numbers/{phone_number_id}": { "get": { "operationId": "phone_numbers_retrieve", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumber" } } }, "description": "" } } }, "put": { "operationId": "phone_numbers_update", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PhoneNumberUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PhoneNumberUpdateRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberUpdate" } } }, "description": "" } } }, "patch": { "operationId": "phone_numbers_partial_update", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPhoneNumberUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPhoneNumberUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPhoneNumberUpdateRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberUpdate" } } }, "description": "" } } }, "delete": { "operationId": "phone_numbers_destroy", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/phone-numbers/{phone_number_id}/transfer": { "post": { "operationId": "phone_numbers_transfer_create", "description": "Move a phone number from one org to another.\n\nBilling anchor clamp (TENANT-04, tightened): ``billing_next_charge_at``\nis a per-number monthly billing anchor consumed by the\n``charge_phone_numbers`` management command (see\n``billing.services.charge_phone_number_monthly``), which charges a\nnumber's *current* organization once ``billing_next_charge_at`` has\npassed and then advances the anchor by another month.\n\nThe original TENANT-04 ruling had a cross-org transfer unconditionally\nreset the anchor to \"transfer time + 1 month\", so the target org\nalways started a fresh monthly cycle at the moment of transfer. That\nruling is superseded: it opened a billing \"ping-pong\" loophole, since\nevery transfer pushed the anchor a full month out -- bouncing a\nnumber between two orgs more often than monthly slid the anchor\nforever and the monthly fee was never charged.\n\nThe current rule clamps the anchor instead of resetting it, so a\ntransfer can only ever pull the anchor *closer* to now, never push it\nfurther out:\n\n new_anchor = max(now, min(existing_anchor, now + 1 month))\n (existing_anchor is None) -> now + 1 month\n\nEffects:\n - A genuine transfer of a number with an anchor already due soon\n (or any time within the next month) keeps that existing charge\n schedule -- whoever holds the number when the fee comes due pays\n it, so total fees are unchanged for same-owner reorgs. This is\n intentionally *not* prorated: the source org is not refunded for\n the unused remainder of its last charged cycle, and the target is\n not charged immediately upon transfer.\n - An overdue anchor (in the past, e.g. the reconciliation command\n just hasn't run yet) clamps to \"now\", so the new holder is\n charged at the next reconciliation instead of inheriting an\n ever-sliding future date.\n - A number with no billing history (``billing_next_charge_at`` is\n None) has no existing anchor to clamp, so it falls back to \"now +\n 1 month\", same as the original ruling's fresh-cycle behavior.\n - Ping-pong transfers gain nothing: the clamp can only move the\n anchor earlier or leave it unchanged, never later, so hopping a\n number between orgs cannot delay the charge indefinitely.", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/phone-numbers/{phone_number_id}/versions": { "get": { "operationId": "phone_numbers_versions_retrieve", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/phone-numbers/{phone_number_id}/verify-voip": { "post": { "operationId": "phone_numbers_verify_voip_create", "description": "Verify an imported number — places a real, carrier-billed probe call.\n\nAdmin-only (like import/provision, which it follows), rate-limited per\nuser, and serialised per number so two clicks cannot dial twice. The\nflow itself lives in verification_flow (shared with the re-proof job).", "parameters": [ { "in": "path", "name": "phone_number_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-numbers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/phone-number-labels": { "get": { "operationId": "phone_number_labels_retrieve", "description": "List all phone-number labels for an org, or create/update one (upsert).", "tags": [ "phone-number-labels" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "phone_number_labels_create", "description": "List all phone-number labels for an org, or create/update one (upsert).", "tags": [ "phone-number-labels" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/phone-number-labels/{label_id}": { "delete": { "operationId": "phone_number_labels_destroy", "description": "Delete a single phone-number label.", "parameters": [ { "in": "path", "name": "label_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "phone-number-labels" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/voip-connections": { "get": { "operationId": "voip_connections_list", "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoipConnection" } } } }, "description": "" } } }, "post": { "operationId": "voip_connections_create", "tags": [ "voip-connections" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipConnectionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VoipConnectionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VoipConnectionRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipConnection" } } }, "description": "" } } } }, "/v1/voip-connections/suggest-name": { "post": { "operationId": "voip_connections_suggest_name_create", "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voip-connections/test": { "post": { "operationId": "voip_connections_test_create", "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voip-connections/{connection_id}": { "patch": { "operationId": "voip_connections_partial_update", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "voip_connections_destroy", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/voip-connections/{connection_id}/available-numbers": { "get": { "operationId": "voip_connections_available_numbers_retrieve", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voip-connections/{connection_id}/import-numbers": { "post": { "operationId": "voip_connections_import_numbers_create", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voip-connections/{connection_id}/search-numbers": { "get": { "operationId": "voip_connections_search_numbers_retrieve", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/voip-connections/{connection_id}/provision-number": { "post": { "operationId": "voip_connections_provision_number_create", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "voip-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/webhook": { "get": { "operationId": "webhook_retrieve", "tags": [ "webhook" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationWebhook" } } }, "description": "" } } }, "put": { "operationId": "webhook_update", "tags": [ "webhook" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationWebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrganizationWebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrganizationWebhookRequest" } } }, "required": true }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationWebhook" } } }, "description": "" } } }, "patch": { "operationId": "webhook_partial_update", "tags": [ "webhook" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationWebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationWebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationWebhookRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationWebhook" } } }, "description": "" } } } }, "/v1/integrations/test-request": { "post": { "operationId": "integrations_test_request_create", "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/integrations": { "get": { "operationId": "integrations_retrieve", "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "integrations_create", "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/mcp-servers": { "get": { "operationId": "mcp_servers_retrieve", "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "mcp_servers_create", "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/mcp-servers/{server_id}": { "get": { "operationId": "mcp_servers_retrieve_2", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "mcp_servers_partial_update", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "mcp_servers_destroy", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/mcp-servers/{server_id}/sync-tools": { "post": { "operationId": "mcp_servers_sync_tools_create", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "mcp-servers" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/provider-connections": { "get": { "operationId": "provider_connections_retrieve", "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/provider-connections/{connection_id}": { "get": { "operationId": "provider_connections_retrieve_2", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "provider_connections_partial_update", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "provider_connections_destroy", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/provider-connections/{connection_id}/sheets/picker-token": { "post": { "operationId": "provider_connections_sheets_picker_token_create", "description": "Hands the browser the connection's own access token for the Google Picker.\n\nUnder `drive.file` the server has no grant on a spreadsheet until the user picks\nit, and the grant is recorded against the credential that ran the Picker session.\nMinting the token from this connection — rather than a separate browser-side\ntoken client — guarantees the picked-file grant lands on the very refresh token\nthe tool executor later uses, instead of relying on grants being project-scoped\nacross our per-environment OAuth clients.\n\nThe token is short-lived and belongs to the grant this org admin already\nestablished, so handing it back to that same admin's browser exposes nothing\nthey cannot already reach. It stays narrow only because the Sheets flow omits\n`include_granted_scopes` — with it, this token would union in every other\nscope the account granted this client. Keep that off.", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/provider-connections/{connection_id}/sheets/inspect": { "post": { "operationId": "provider_connections_sheets_inspect_create", "description": "Lists tab names for a spreadsheet the Picker just granted.\n\nTakes the Picker's file id, not a pasted URL: under drive.file the server can\nonly open ids the user explicitly picked.", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/provider-connections/{connection_id}/sheets/configure": { "post": { "operationId": "provider_connections_sheets_configure_create", "parameters": [ { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/provider-connections/{connection_id}/agents/{agent_id}": { "put": { "operationId": "provider_connections_agents_update", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "provider_connections_agents_destroy", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "connection_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/provider-connections/{provider}/api-key": { "post": { "operationId": "provider_connections_api_key_create", "parameters": [ { "in": "path", "name": "provider", "schema": { "type": "string" }, "required": true } ], "tags": [ "provider-connections" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/mcp": { "post": { "operationId": "mcp_create", "tags": [ "mcp" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/integrations/{integration_id}/transfer": { "post": { "operationId": "integrations_transfer_create", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/integrations/{integration_id}/versions": { "get": { "operationId": "integrations_versions_retrieve", "parameters": [ { "in": "path", "name": "integration_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "integrations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/developer/api-keys": { "get": { "operationId": "developer_api_keys_retrieve", "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "developer_api_keys_create", "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/developer/api-keys/{key_id}": { "delete": { "operationId": "developer_api_keys_destroy", "parameters": [ { "in": "path", "name": "key_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/developer/webhook-endpoints": { "get": { "operationId": "developer_webhook_endpoints_retrieve", "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "developer_webhook_endpoints_create", "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/developer/webhook-endpoints/{endpoint_id}": { "patch": { "operationId": "developer_webhook_endpoints_partial_update", "parameters": [ { "in": "path", "name": "endpoint_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "developer_webhook_endpoints_destroy", "parameters": [ { "in": "path", "name": "endpoint_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "developer" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/developer/webhook-endpoints/{endpoint_id}/test": { "post": { "operationId": "developer_webhook_endpoints_test_create", "description": "Send a synthetic webhook.test event through the normal signed delivery pipeline to one endpoint.", "parameters": [ { "in": "path", "name": "endpoint_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookTestDelivery" } } }, "description": "" } } } }, "/v1/calls": { "get": { "operationId": "calls_retrieve", "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/export": { "get": { "operationId": "calls_export_retrieve", "description": "Export calls for an organization as CSV or JSON.\n\nHonors the same filter query params as the call-list endpoint\n(agent_id, direction, status, phone_number, from_number, to_number,\nstart_date, end_date) — QA4 CALLS-16: this used to ignore every filter\nand silently export an org-wide superset of what the caller filtered.\n\nCSV returns high-level call metadata (no transcripts).\nJSON returns metadata plus the full transcript for each call.\nCapped at the 1,000 most recent calls matching the filters; when the\nfiltered result exceeds the cap, the response carries an\n``X-Truncated: true`` header (and ``X-Total-Count`` with the untruncated\nmatch count) — JSON responses also carry a ``truncated`` body field.", "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/party-numbers": { "get": { "operationId": "calls_party_numbers_retrieve", "description": "Distinct phone numbers seen on either side of the org's calls.\n\nBacks the call-history From / To filter autocomplete: the filter used to\noffer only org-owned and labeled numbers, so an external caller could\nnever be picked. ``q`` is matched as a digit substring (punctuation in\nthe query is ignored) so \"(631) 456\" finds \"+16314566068\". Results are\nordered by the most recent call the number appeared on.", "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}": { "get": { "operationId": "calls_retrieve_2", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/audio": { "get": { "operationId": "calls_audio_retrieve", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/consent-announcements/{asset_hash}": { "get": { "operationId": "consent_announcements_retrieve", "description": "Stream the exact consent-announcement asset that played on an org call.\n\nAuthorization is purely evidence linkage (mirroring CallAudioView's org\nscoping): the requesting user's org must own a call whose stored\nconsent_evidence names this asset hash. This endpoint never becomes a\ngeneral artifact fetcher — it only serves blobs under the\nconsent-announcements// prefix recorded on such a call,\nand only when the blob's content hash matches the requested hash.", "parameters": [ { "in": "path", "name": "asset_hash", "schema": { "type": "string" }, "required": true } ], "tags": [ "consent-announcements" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/caller-audio": { "get": { "operationId": "calls_caller_audio_retrieve", "description": "Serve one caller-audio span after checking call and reference scope.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/span-audio": { "get": { "operationId": "calls_span_audio_retrieve", "description": "Serve one caller-audio span after checking call and reference scope.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/listen": { "post": { "operationId": "calls_listen_create", "description": "Mint a hidden, subscribe-only LiveKit token for a live call.\n\nLets an org member hear an in-progress conversation from the browser.\nThe listener joins the call's existing room with ``hidden=True`` and no\npublish grant, so the agent, the caller, and the room-composite\nrecording are all unaffected.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/whisper": { "post": { "operationId": "calls_whisper_create", "description": "Send private operator guidance to an in-progress Core call session.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/transcript": { "get": { "operationId": "calls_transcript_retrieve", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/grade": { "get": { "operationId": "calls_grade_retrieve", "description": "Read or synchronously grade a call.\n\nEvery paid grading invocation, forced or not, must claim the call first.\nThe standard claim window is 15 minutes. When the latest grade is a\nretryable failure, the claim window is shortened to 90 seconds so the\nclient can follow the retry guidance. The claim bounds NEW invocations\nto one per window; a grading run that itself outlives the 90s retry\nwindow can therefore briefly overlap the next claimed retry — worst\ncase one extra paid invocation per 90s on a single call, accepted in\nexchange for honest retry guidance.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "calls_grade_create", "description": "Read or synchronously grade a call.\n\nEvery paid grading invocation, forced or not, must claim the call first.\nThe standard claim window is 15 minutes. When the latest grade is a\nretryable failure, the claim window is shortened to 90 seconds so the\nclient can follow the retry guidance. The claim bounds NEW invocations\nto one per window; a grading run that itself outlives the 90s retry\nwindow can therefore briefly overlap the next claimed retry — worst\ncase one extra paid invocation per 90s on a single call, accepted in\nexchange for honest retry guidance.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/history": { "get": { "operationId": "calls_history_retrieve", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/calls/{call_id}/issue-reports": { "get": { "operationId": "calls_issue_reports_retrieve", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "calls_issue_reports_create", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/issue-reports": { "get": { "operationId": "issue_reports_retrieve", "tags": [ "issue-reports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "issue_reports_partial_update", "description": "Bulk-update status for multiple issue reports.\n\nTwo request shapes:\n - ``{trace_ids, status}`` (legacy) — updates exactly those rows.\n - ``{trace_ids, status, pattern_key}`` — ALSO updates every other\n report in the org that belongs to the same recurring-issue\n pattern as the given trace_ids, even ones the client hasn't\n paged in yet (QA4 CALLS-07: without this, a bulk action on a\n pattern only ever reached whatever page(s) were loaded, so\n unloaded occurrences stayed open and the pattern would flip\n back to \"Open\" once more pages loaded).", "tags": [ "issue-reports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/issue-clusters": { "get": { "operationId": "issue_clusters_retrieve", "tags": [ "issue-clusters" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/issue-clusters/{cluster_id}": { "patch": { "operationId": "issue_clusters_partial_update", "parameters": [ { "in": "path", "name": "cluster_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "issue-clusters" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/issue-clusters/{cluster_id}/escalate": { "post": { "operationId": "issue_clusters_escalate_create", "parameters": [ { "in": "path", "name": "cluster_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "issue-clusters" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/issue-reports/{trace_id}": { "patch": { "operationId": "issue_reports_partial_update_2", "description": "PATCH a single issue report's status by trace_id.", "parameters": [ { "in": "path", "name": "trace_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "issue-reports" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations": { "get": { "operationId": "investigations_retrieve", "description": "POST /v1/investigations — create a new investigation.\nGET /v1/investigations — list investigations for the org.", "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "investigations_create", "description": "POST /v1/investigations — create a new investigation.\nGET /v1/investigations — list investigations for the org.", "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}": { "get": { "operationId": "investigations_retrieve_2", "description": "GET /v1/investigations/ — full investigation with nested children.\nPATCH /v1/investigations/ — update config or dismiss.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "investigations_partial_update", "description": "GET /v1/investigations/ — full investigation with nested children.\nPATCH /v1/investigations/ — update config or dismiss.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/hypotheses": { "post": { "operationId": "investigations_hypotheses_create", "description": "POST /v1/investigations//hypotheses — trigger async hypothesis generation.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/search": { "post": { "operationId": "investigations_search_create", "description": "POST /v1/investigations//search — autonomously find and confirm a fix.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/candidates/manual": { "post": { "operationId": "investigations_candidates_manual_create", "description": "POST /v1/investigations//candidates/manual — add a user-authored candidate.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/candidates/{candidate_id}/experiments": { "post": { "operationId": "investigations_candidates_experiments_create", "description": "POST /v1/investigations//candidates//experiments — start an experiment.", "parameters": [ { "in": "path", "name": "candidate_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/experiments/{experiment_id}": { "get": { "operationId": "investigations_experiments_retrieve", "description": "GET /v1/investigations//experiments/ — poll experiment progress.", "parameters": [ { "in": "path", "name": "experiment_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/investigations/{investigation_id}/apply": { "post": { "operationId": "investigations_apply_create", "description": "POST /v1/investigations//apply — apply a candidate fix.", "parameters": [ { "in": "path", "name": "investigation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "investigations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/call": { "post": { "operationId": "call_create", "tags": [ "call" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/realtime/sessions": { "post": { "operationId": "realtime_sessions_create", "tags": [ "realtime" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/realtime/sessions/{call_id}/live-transcripts": { "post": { "operationId": "realtime_sessions_live_transcripts_create", "description": "The bridge reports a session that turned live transcripts on mid-call.\n\nsession.update can enable the option after the mint (saved-agent sessions\nstart at connect, before any session.update). Billing is per session, so\nthe flag only ever goes to True; turning the stream off later stops the\ntranscriber but does not remove the surcharge.", "parameters": [ { "in": "path", "name": "call_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "realtime" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/mic-session": { "post": { "operationId": "mic_session_create", "tags": [ "mic-session" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/simulations": { "get": { "operationId": "simulations_retrieve", "tags": [ "simulations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "simulations_create", "tags": [ "simulations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/simulations/batches": { "get": { "operationId": "simulations_batches_retrieve", "description": "List and create test call batches.\n\nA batch spawns N staggered ``SimulationRun`` instances against the same\ntarget. Runs are created synchronously (fast) and then launched\nasynchronously via a background thread that sleeps ``stagger_seconds``\nbetween each launch.", "tags": [ "simulations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "simulations_batches_create", "description": "List and create test call batches.\n\nA batch spawns N staggered ``SimulationRun`` instances against the same\ntarget. Runs are created synchronously (fast) and then launched\nasynchronously via a background thread that sleeps ``stagger_seconds``\nbetween each launch.", "tags": [ "simulations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/simulations/batches/{batch_id}": { "get": { "operationId": "simulations_batches_retrieve_2", "description": "Retrieve a single test call batch with its current status and run IDs.", "parameters": [ { "in": "path", "name": "batch_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "simulations" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/test-calls": { "get": { "operationId": "test_calls_retrieve", "tags": [ "test-calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "test_calls_create", "tags": [ "test-calls" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/test-call-batches": { "get": { "operationId": "test_call_batches_retrieve", "description": "List and create test call batches.\n\nA batch spawns N staggered ``SimulationRun`` instances against the same\ntarget. Runs are created synchronously (fast) and then launched\nasynchronously via a background thread that sleeps ``stagger_seconds``\nbetween each launch.", "tags": [ "test-call-batches" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "test_call_batches_create", "description": "List and create test call batches.\n\nA batch spawns N staggered ``SimulationRun`` instances against the same\ntarget. Runs are created synchronously (fast) and then launched\nasynchronously via a background thread that sleeps ``stagger_seconds``\nbetween each launch.", "tags": [ "test-call-batches" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/test-call-batches/{batch_id}": { "get": { "operationId": "test_call_batches_retrieve_2", "description": "Retrieve a single test call batch with its current status and run IDs.", "parameters": [ { "in": "path", "name": "batch_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "test-call-batches" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/billing": { "get": { "operationId": "billing_retrieve", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingAccount" } } }, "description": "" } } }, "patch": { "operationId": "billing_partial_update", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/billing/top-up": { "post": { "operationId": "billing_top_up_create", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/billing/transactions": { "get": { "operationId": "billing_transactions_retrieve", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/billing/setup-intent": { "post": { "operationId": "billing_setup_intent_create", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/billing/default-payment-method": { "post": { "operationId": "billing_default_payment_method_create", "tags": [ "billing" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/onboarding": { "get": { "operationId": "onboarding_retrieve", "description": "Return the current onboarding state for the authenticated org.", "tags": [ "onboarding" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/onboarding/dismiss": { "post": { "operationId": "onboarding_dismiss_create", "description": "Mark onboarding as dismissed for the authenticated org.", "tags": [ "onboarding" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/onboarding/undismiss": { "post": { "operationId": "onboarding_undismiss_create", "description": "Clear the dismissed state so onboarding re-appears.", "tags": [ "onboarding" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/onboarding/agent-talk/skip": { "post": { "operationId": "onboarding_agent_talk_skip_create", "description": "Mark the agent step complete after the user skips the talk step.\n\nFired by the web app when the agent-builder tour is skipped; the mic\n\"Talk\" test is optional, so skipping it still checks off the step\n(as long as the org actually has an agent).", "tags": [ "onboarding" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/publishable-key": { "get": { "operationId": "publishable_key_retrieve", "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "publishable_key_create", "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/publishable-key/{key_id}": { "get": { "operationId": "publishable_key_retrieve_2", "parameters": [ { "in": "path", "name": "key_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "publishable_key_partial_update", "parameters": [ { "in": "path", "name": "key_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "publishable_key_destroy", "parameters": [ { "in": "path", "name": "key_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/publishable-key/{key_id}/transfer": { "post": { "operationId": "publishable_key_transfer_create", "description": "Transfer (copy or move) a publishable key / web widget to another org.", "parameters": [ { "in": "path", "name": "key_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "publishable-key" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/members": { "get": { "operationId": "members_retrieve", "tags": [ "members" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/members/{member_id}": { "delete": { "operationId": "members_destroy", "parameters": [ { "in": "path", "name": "member_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "members" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/members/{member_id}/role": { "patch": { "operationId": "members_role_partial_update", "parameters": [ { "in": "path", "name": "member_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "members" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/members/{member_id}/transfer-ownership": { "post": { "operationId": "members_transfer_ownership_create", "parameters": [ { "in": "path", "name": "member_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "members" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/invites": { "get": { "operationId": "invites_retrieve", "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "invites_create", "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/invites/{invite_id}": { "delete": { "operationId": "invites_destroy", "parameters": [ { "in": "path", "name": "invite_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/invites/{token}": { "get": { "operationId": "invites_retrieve_2", "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "required": true } ], "tags": [ "invites" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } }, "/v1/invites/{token}/accept": { "post": { "operationId": "invites_accept_create", "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "required": true } ], "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/invites/{token}/decline": { "post": { "operationId": "invites_decline_create", "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "required": true } ], "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/invites/{token}/request-access": { "post": { "operationId": "invites_request_access_create", "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "required": true } ], "tags": [ "invites" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/leave": { "post": { "operationId": "leave_create", "tags": [ "leave" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/variants": { "get": { "operationId": "agents_variants_retrieve", "description": "GET: list variants for an agent. POST: create a new variant.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "agents_variants_create", "description": "GET: list variants for an agent. POST: create a new variant.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/variants/{variant_id}": { "patch": { "operationId": "agents_variants_partial_update", "description": "PATCH/DELETE a single variant.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "variant_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "agents_variants_destroy", "description": "PATCH/DELETE a single variant.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true }, { "in": "path", "name": "variant_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/split-testing": { "post": { "operationId": "agents_split_testing_create", "description": "POST: enable/disable split testing on an agent.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/agents/{agent_id}/variant-stats": { "get": { "operationId": "agents_variant_stats_retrieve", "description": "GET: per-variant call stats for an agent's A/B test.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "agents" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents/import-url": { "post": { "operationId": "knowledge_documents_import_url_create", "description": "Create a knowledge document from a customer-pasted web page URL.\n\nThe document is created in ``pending`` and the fetch + extraction run in\nthe durable ingestion queue: pages are slow and flaky, so the request\nitself never touches the network beyond one DNS-level safety check.", "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents": { "get": { "operationId": "knowledge_documents_retrieve", "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "knowledge_documents_create", "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents/{document_id}": { "get": { "operationId": "knowledge_documents_retrieve_2", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "knowledge_documents_partial_update", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "knowledge_documents_destroy", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/knowledge/documents/{document_id}/retry": { "post": { "operationId": "knowledge_documents_retry_create", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents/{document_id}/original": { "get": { "operationId": "knowledge_documents_original_retrieve", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents/{document_id}/replace": { "post": { "operationId": "knowledge_documents_replace_create", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/documents/{document_id}/refresh": { "post": { "operationId": "knowledge_documents_refresh_create", "description": "Re-fetch a url-origin document through the durable ingestion queue.", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge/search": { "post": { "operationId": "knowledge_search_create", "tags": [ "knowledge" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge-bases": { "get": { "operationId": "knowledge_bases_retrieve", "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "knowledge_bases_create", "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge-bases/{knowledge_base_id}": { "get": { "operationId": "knowledge_bases_retrieve_2", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "knowledge_bases_partial_update", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "knowledge_bases_destroy", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/knowledge-bases/{knowledge_base_id}/documents": { "get": { "operationId": "knowledge_bases_documents_retrieve", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "knowledge_bases_documents_create", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}": { "patch": { "operationId": "knowledge_bases_documents_partial_update", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "knowledge_bases_documents_destroy", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/retry": { "post": { "operationId": "knowledge_bases_documents_retry_create", "parameters": [ { "in": "path", "name": "document_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/knowledge-bases/{knowledge_base_id}/search": { "post": { "operationId": "knowledge_bases_search_create", "parameters": [ { "in": "path", "name": "knowledge_base_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "knowledge-bases" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/v1/widget/session": { "post": { "operationId": "widget_session_create", "tags": [ "widget" ], "security": [ { "bearerAuth": [] }, {} ], "responses": { "200": { "description": "No response body" } } } } }, "components": { "schemas": { "AcknowledgementFeedbackModeEnum": { "enum": [ "acknowledgement", "tick" ], "type": "string", "description": "* `acknowledgement` - Spoken acknowledgement\n* `tick` - Ticking sound" }, "AcknowledgementPromptModeEnum": { "enum": [ "auto", "manual" ], "type": "string", "description": "* `auto` - Auto\n* `manual` - Manual" }, "Agent": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "prompt": { "type": "string" }, "voice": { "type": "string", "maxLength": 100 }, "primary_language": { "type": "string", "description": "Primary language code (ISO 639, e.g. 'en', 'es'). Determines the default TTS provider and locale for the agent.", "maxLength": 16 }, "additional_languages": { "type": "array", "items": { "type": "string", "maxLength": 16 } }, "native_voice_switching": { "type": "boolean" }, "product": { "$ref": "#/components/schemas/ProductEnum" }, "thinking_level": { "$ref": "#/components/schemas/ThinkingLevelEnum" }, "background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "acknowledgement_prompt_mode": { "$ref": "#/components/schemas/AcknowledgementPromptModeEnum" }, "acknowledgement_prompt": { "type": "string" }, "acknowledgement_feedback_mode": { "$ref": "#/components/schemas/AcknowledgementFeedbackModeEnum" }, "inbound_speak_order": { "$ref": "#/components/schemas/InboundSpeakOrderEnum" }, "outbound_speak_order": { "$ref": "#/components/schemas/OutboundSpeakOrderEnum" }, "voicemail_action": { "$ref": "#/components/schemas/VoicemailActionEnum" }, "voicemail_message": { "type": "string", "description": "Voicemail TTS template. Supported variables: {agent_name}, {org_name}." }, "silence_interval_seconds": { "type": "integer", "maximum": 120, "minimum": 5 }, "silence_max_checkins": { "type": "integer", "maximum": 10, "minimum": 1 }, "silence_checkins_enabled": { "type": "boolean", "description": "Whether the agent proactively checks in and eventually hangs up during caller silence." }, "silence_hangup_seconds": { "type": "integer", "maximum": 3600, "minimum": 60, "description": "Caller-idle seconds before a silent hangup when silence check-ins are disabled." }, "max_call_duration_seconds": { "type": "integer", "maximum": 14400, "minimum": 60, "nullable": true, "description": "Maximum call length in seconds. Null means no limit." }, "ring_duration_seconds": { "type": "integer", "maximum": 120, "minimum": 5, "nullable": true, "description": "Outbound and transfer ringing time in seconds. Null uses platform defaults." }, "connect_tone_enabled": { "type": "boolean", "description": "Whether to play a short connection tone before the agent begins the call." }, "typing_sounds_enabled": { "type": "boolean" }, "play_sound_asset": { "oneOf": [ { "$ref": "#/components/schemas/PlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "speak_uninterruptible_enabled": { "type": "boolean" }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_override": { "$ref": "#/components/schemas/AiLiveProcessingDisclosureOverrideEnum" }, "send_email_enabled": { "type": "boolean", "description": "Whether the agent may send an email to the configured recipient during a call." }, "send_email_recipient": { "type": "string", "format": "email", "maxLength": 254 }, "consent_announcement_enabled": { "type": "boolean" }, "consent_announcement_text": { "type": "string" }, "consent_disabled_reason": { "type": "string", "readOnly": true, "description": "Platform-managed provenance for an announcement exemption. Existing agents are marked grandfathered-2026-07." }, "audio_context_mode": { "allOf": [ { "$ref": "#/components/schemas/AudioContextModeEnum" } ], "description": "Storm audio context window. 'reduced' lowers latency by using less prior audio context.\n\n* `full` - Full\n* `reduced` - Reduced" }, "watchdog_enabled": { "type": "boolean" }, "additional_audio_context": { "type": "boolean", "nullable": true, "description": "Override the direction-based depth of recent caller audio included in model context." }, "integrations": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "knowledge_bases": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBase" }, "readOnly": true }, "knowledge_documents": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocument" }, "readOnly": true }, "mcp_servers": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "tool_collision_warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "widget_enabled": { "type": "boolean" }, "split_testing_enabled": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "draft_name": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_prompt": { "type": "string", "nullable": true }, "draft_voice": { "type": "string", "nullable": true, "maxLength": 100 }, "draft_primary_language": { "type": "string", "nullable": true, "maxLength": 16 }, "draft_additional_languages": { "type": "array", "items": { "type": "string", "maxLength": 16 }, "readOnly": true }, "draft_native_voice_switching": { "type": "boolean", "nullable": true }, "draft_product": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftProductEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_thinking_level": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftThinkingLevelEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementPromptModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt": { "type": "string", "nullable": true }, "draft_acknowledgement_feedback_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementFeedbackModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_inbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftInboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_outbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftOutboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_action": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftVoicemailActionEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_message": { "type": "string", "nullable": true }, "draft_silence_interval_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_max_checkins": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_checkins_enabled": { "type": "boolean", "nullable": true }, "draft_silence_hangup_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_max_call_duration_seconds": { "type": "integer", "readOnly": true, "nullable": true }, "draft_ring_duration_seconds": { "type": "integer", "readOnly": true, "nullable": true }, "draft_connect_tone_enabled": { "type": "boolean", "nullable": true }, "draft_typing_sounds_enabled": { "type": "boolean", "nullable": true }, "draft_play_sound_asset": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftPlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_speak_uninterruptible_enabled": { "type": "boolean", "nullable": true }, "draft_call_recording_enabled": { "type": "boolean", "nullable": true }, "draft_ai_live_processing_disclosure_override": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAiLiveProcessingDisclosureOverrideEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_send_email_enabled": { "type": "boolean", "nullable": true }, "draft_send_email_recipient": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "draft_consent_announcement_enabled": { "type": "boolean", "nullable": true }, "draft_consent_announcement_text": { "type": "string", "nullable": true }, "draft_audio_context_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAudioContextModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_watchdog_enabled": { "type": "boolean", "nullable": true }, "draft_additional_audio_context": { "type": "boolean", "nullable": true }, "draft_widget_enabled": { "type": "boolean", "nullable": true }, "draft_split_testing_enabled": { "type": "boolean", "nullable": true }, "draft_integration_ids": { "nullable": true }, "draft_knowledge_base_ids": { "nullable": true }, "draft_knowledge_document_ids": { "nullable": true }, "draft_mcp_server_ids": { "nullable": true }, "draft_updated_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "has_draft": { "type": "boolean", "readOnly": true } }, "required": [ "consent_disabled_reason", "created_at", "draft_additional_languages", "draft_max_call_duration_seconds", "draft_ring_duration_seconds", "draft_updated_at", "has_draft", "id", "integrations", "knowledge_bases", "knowledge_documents", "mcp_servers", "name", "prompt", "tool_collision_warnings", "updated_at", "voice" ] }, "AgentRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "prompt": { "type": "string", "minLength": 1 }, "voice": { "type": "string", "minLength": 1, "maxLength": 100 }, "primary_language": { "type": "string", "minLength": 1, "description": "Primary language code (ISO 639, e.g. 'en', 'es'). Determines the default TTS provider and locale for the agent.", "maxLength": 16 }, "additional_languages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 16 } }, "native_voice_switching": { "type": "boolean" }, "product": { "$ref": "#/components/schemas/ProductEnum" }, "thinking_level": { "$ref": "#/components/schemas/ThinkingLevelEnum" }, "background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "acknowledgement_prompt_mode": { "$ref": "#/components/schemas/AcknowledgementPromptModeEnum" }, "acknowledgement_prompt": { "type": "string" }, "acknowledgement_feedback_mode": { "$ref": "#/components/schemas/AcknowledgementFeedbackModeEnum" }, "inbound_speak_order": { "$ref": "#/components/schemas/InboundSpeakOrderEnum" }, "outbound_speak_order": { "$ref": "#/components/schemas/OutboundSpeakOrderEnum" }, "voicemail_action": { "$ref": "#/components/schemas/VoicemailActionEnum" }, "voicemail_message": { "type": "string", "description": "Voicemail TTS template. Supported variables: {agent_name}, {org_name}." }, "silence_interval_seconds": { "type": "integer", "maximum": 120, "minimum": 5 }, "silence_max_checkins": { "type": "integer", "maximum": 10, "minimum": 1 }, "silence_checkins_enabled": { "type": "boolean", "description": "Whether the agent proactively checks in and eventually hangs up during caller silence." }, "silence_hangup_seconds": { "type": "integer", "maximum": 3600, "minimum": 60, "description": "Caller-idle seconds before a silent hangup when silence check-ins are disabled." }, "max_call_duration_seconds": { "type": "integer", "maximum": 14400, "minimum": 60, "nullable": true, "description": "Maximum call length in seconds. Null means no limit." }, "ring_duration_seconds": { "type": "integer", "maximum": 120, "minimum": 5, "nullable": true, "description": "Outbound and transfer ringing time in seconds. Null uses platform defaults." }, "connect_tone_enabled": { "type": "boolean", "description": "Whether to play a short connection tone before the agent begins the call." }, "typing_sounds_enabled": { "type": "boolean" }, "play_sound_asset": { "oneOf": [ { "$ref": "#/components/schemas/PlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "speak_uninterruptible_enabled": { "type": "boolean" }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_override": { "$ref": "#/components/schemas/AiLiveProcessingDisclosureOverrideEnum" }, "send_email_enabled": { "type": "boolean", "description": "Whether the agent may send an email to the configured recipient during a call." }, "send_email_recipient": { "type": "string", "format": "email", "maxLength": 254 }, "consent_announcement_enabled": { "type": "boolean" }, "consent_announcement_text": { "type": "string", "minLength": 1 }, "audio_context_mode": { "allOf": [ { "$ref": "#/components/schemas/AudioContextModeEnum" } ], "description": "Storm audio context window. 'reduced' lowers latency by using less prior audio context.\n\n* `full` - Full\n* `reduced` - Reduced" }, "watchdog_enabled": { "type": "boolean" }, "additional_audio_context": { "type": "boolean", "nullable": true, "description": "Override the direction-based depth of recent caller audio included in model context." }, "widget_enabled": { "type": "boolean" }, "split_testing_enabled": { "type": "boolean" }, "draft_name": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_prompt": { "type": "string", "nullable": true }, "draft_voice": { "type": "string", "nullable": true, "maxLength": 100 }, "draft_primary_language": { "type": "string", "nullable": true, "maxLength": 16 }, "draft_native_voice_switching": { "type": "boolean", "nullable": true }, "draft_product": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftProductEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_thinking_level": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftThinkingLevelEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementPromptModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt": { "type": "string", "nullable": true }, "draft_acknowledgement_feedback_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementFeedbackModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_inbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftInboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_outbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftOutboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_action": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftVoicemailActionEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_message": { "type": "string", "nullable": true }, "draft_silence_interval_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_max_checkins": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_checkins_enabled": { "type": "boolean", "nullable": true }, "draft_silence_hangup_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_connect_tone_enabled": { "type": "boolean", "nullable": true }, "draft_typing_sounds_enabled": { "type": "boolean", "nullable": true }, "draft_play_sound_asset": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftPlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_speak_uninterruptible_enabled": { "type": "boolean", "nullable": true }, "draft_call_recording_enabled": { "type": "boolean", "nullable": true }, "draft_ai_live_processing_disclosure_override": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAiLiveProcessingDisclosureOverrideEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_send_email_enabled": { "type": "boolean", "nullable": true }, "draft_send_email_recipient": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "draft_consent_announcement_enabled": { "type": "boolean", "nullable": true }, "draft_consent_announcement_text": { "type": "string", "nullable": true }, "draft_audio_context_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAudioContextModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_watchdog_enabled": { "type": "boolean", "nullable": true }, "draft_additional_audio_context": { "type": "boolean", "nullable": true }, "draft_widget_enabled": { "type": "boolean", "nullable": true }, "draft_split_testing_enabled": { "type": "boolean", "nullable": true }, "draft_integration_ids": { "nullable": true }, "draft_knowledge_base_ids": { "nullable": true }, "draft_knowledge_document_ids": { "nullable": true }, "draft_mcp_server_ids": { "nullable": true } }, "required": [ "name", "prompt", "voice" ] }, "AiLiveProcessingDisclosureOverrideEnum": { "enum": [ "inherit", "on", "off" ], "type": "string", "description": "* `inherit` - Inherit organization setting\n* `on` - On\n* `off` - Off" }, "AudioContextModeEnum": { "enum": [ "full", "reduced" ], "type": "string", "description": "* `full` - Full\n* `reduced` - Reduced" }, "BillingAccount": { "type": "object", "properties": { "balance_cents": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "available_cash_cents": { "type": "string", "readOnly": true }, "test_call_budget_cents": { "type": "integer", "readOnly": true }, "test_call_budget_remaining_cents": { "type": "integer", "readOnly": true }, "balance_usd": { "type": "string", "readOnly": true }, "currency": { "type": "string", "maxLength": 8 }, "auto_reload_enabled": { "type": "boolean" }, "auto_reload_minimum_cents": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "auto_reload_amount_cents": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "auto_reload_monthly_limit_cents": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "monthly_spending_limit_cents": { "type": "integer", "readOnly": true, "nullable": true }, "current_month_usage_spend_cents": { "type": "integer", "readOnly": true }, "spending_limit_reached": { "type": "boolean", "readOnly": true }, "auto_reload_in_progress": { "type": "boolean" }, "auto_reload_last_error": { "type": "string", "nullable": true }, "last_manual_topup_error": { "type": "string", "readOnly": true, "nullable": true }, "last_manual_topup_intent_id": { "type": "string", "readOnly": true, "nullable": true }, "has_payment_method": { "type": "boolean", "readOnly": true }, "has_ever_topped_up": { "type": "boolean", "readOnly": true } }, "required": [ "available_cash_cents", "balance_usd", "current_month_usage_spend_cents", "has_ever_topped_up", "has_payment_method", "last_manual_topup_error", "last_manual_topup_intent_id", "monthly_spending_limit_cents", "spending_limit_reached", "test_call_budget_cents", "test_call_budget_remaining_cents" ] }, "BlankEnum": { "enum": [ "" ] }, "DeveloperWebhookTestDelivery": { "type": "object", "properties": { "success": { "type": "boolean", "readOnly": true }, "event_id": { "type": "string", "format": "uuid", "readOnly": true }, "event_type": { "type": "string", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "response_code": { "type": "integer", "readOnly": true, "nullable": true }, "error": { "type": "string", "readOnly": true } }, "required": [ "error", "event_id", "event_type", "response_code", "status", "success" ] }, "DraftAcknowledgementFeedbackModeEnum": { "enum": [ "acknowledgement", "tick" ], "type": "string", "description": "* `acknowledgement` - Spoken acknowledgement\n* `tick` - Ticking sound" }, "DraftAcknowledgementPromptModeEnum": { "enum": [ "auto", "manual" ], "type": "string", "description": "* `auto` - Auto\n* `manual` - Manual" }, "DraftAiLiveProcessingDisclosureOverrideEnum": { "enum": [ "inherit", "on", "off" ], "type": "string", "description": "* `inherit` - Inherit organization setting\n* `on` - On\n* `off` - Off" }, "DraftAudioContextModeEnum": { "enum": [ "full", "reduced" ], "type": "string", "description": "* `full` - Full\n* `reduced` - Reduced" }, "DraftInboundSpeakOrderEnum": { "enum": [ "agent_first", "caller_first" ], "type": "string", "description": "* `agent_first` - Agent First\n* `caller_first` - Caller First" }, "DraftOutboundSpeakOrderEnum": { "enum": [ "agent_first", "caller_first" ], "type": "string", "description": "* `agent_first` - Agent First\n* `caller_first` - Caller First" }, "DraftPlaySoundAssetEnum": { "enum": [ "chime", "ding", "beep" ], "type": "string", "description": "* `` - None\n* `chime` - Chime\n* `ding` - Ding\n* `beep` - Beep" }, "DraftProductEnum": { "enum": [ "spark", "bolt", "storm-base", "storm-base-with-ack", "storm-extra", "storm-extra-with-ack" ], "type": "string", "description": "* `spark` - Spark\n* `bolt` - Bolt\n* `storm-base` - Storm Base\n* `storm-base-with-ack` - Storm Base + Ack\n* `storm-extra` - Storm Extra\n* `storm-extra-with-ack` - Storm Extra + Ack" }, "DraftThinkingLevelEnum": { "enum": [ "base", "extra" ], "type": "string", "description": "* `base` - Base\n* `extra` - Extra" }, "DraftVoicemailActionEnum": { "enum": [ "prompt", "hangup", "message" ], "type": "string", "description": "* `prompt` - Let the agent decide\n* `hangup` - Hang up\n* `message` - Leave a message" }, "InboundSpeakOrderEnum": { "enum": [ "agent_first", "caller_first" ], "type": "string", "description": "* `agent_first` - Agent First\n* `caller_first` - Caller First" }, "Integration": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "spec": {}, "endpoint": { "nullable": true }, "wizard_input": { "type": "string" }, "validation_status": { "$ref": "#/components/schemas/ValidationStatusEnum" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "display_name", "id", "spec", "updated_at" ] }, "IntegrationRequest": { "type": "object", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "spec": {}, "endpoint": { "nullable": true }, "wizard_input": { "type": "string" }, "validation_status": { "$ref": "#/components/schemas/ValidationStatusEnum" } }, "required": [ "display_name", "spec" ] }, "KnowledgeBase": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "document_count": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "document_count", "id", "name", "updated_at" ] }, "KnowledgeBaseRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string" } }, "required": [ "name" ] }, "KnowledgeDocument": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "source_type": { "allOf": [ { "$ref": "#/components/schemas/SourceTypeEnum" } ], "readOnly": true }, "original_filename": { "type": "string", "readOnly": true }, "mime_type": { "type": "string", "readOnly": true }, "byte_count": { "type": "integer", "readOnly": true }, "estimated_chunk_count": { "type": "integer", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/KnowledgeDocumentStatusEnum" } ], "readOnly": true }, "error": { "type": "string", "readOnly": true }, "chunk_count": { "type": "integer", "readOnly": true }, "source_origin": { "readOnly": true, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SourceOriginEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "source_url": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "fetched_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "byte_count", "chunk_count", "created_at", "error", "estimated_chunk_count", "fetched_at", "id", "mime_type", "name", "original_filename", "source_origin", "source_type", "source_url", "status", "updated_at" ] }, "KnowledgeDocumentRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "content": { "type": "string", "writeOnly": true } }, "required": [ "content", "name" ] }, "KnowledgeDocumentStatusEnum": { "enum": [ "pending", "processing", "ready", "failed" ], "type": "string", "description": "* `pending` - Pending\n* `processing` - Processing\n* `ready` - Ready\n* `failed` - Failed" }, "NullEnum": { "enum": [ null ] }, "Organization": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_enabled": { "type": "boolean", "description": "Play the AI/live-processing disclosure on recording-off calls. Recording-on calls are unaffected." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "updated_at" ] }, "OrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_enabled": { "type": "boolean", "description": "Play the AI/live-processing disclosure on recording-off calls. Recording-on calls are unaffected." } }, "required": [ "name" ] }, "OrganizationWebhook": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 200 }, "secret": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "secret", "updated_at", "url" ] }, "OrganizationWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 200 } }, "required": [ "url" ] }, "OutboundSpeakOrderEnum": { "enum": [ "agent_first", "caller_first" ], "type": "string", "description": "* `agent_first` - Agent First\n* `caller_first` - Caller First" }, "PatchedAgentRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "prompt": { "type": "string", "minLength": 1 }, "voice": { "type": "string", "minLength": 1, "maxLength": 100 }, "primary_language": { "type": "string", "minLength": 1, "description": "Primary language code (ISO 639, e.g. 'en', 'es'). Determines the default TTS provider and locale for the agent.", "maxLength": 16 }, "additional_languages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 16 } }, "native_voice_switching": { "type": "boolean" }, "product": { "$ref": "#/components/schemas/ProductEnum" }, "thinking_level": { "$ref": "#/components/schemas/ThinkingLevelEnum" }, "background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "acknowledgement_prompt_mode": { "$ref": "#/components/schemas/AcknowledgementPromptModeEnum" }, "acknowledgement_prompt": { "type": "string" }, "acknowledgement_feedback_mode": { "$ref": "#/components/schemas/AcknowledgementFeedbackModeEnum" }, "inbound_speak_order": { "$ref": "#/components/schemas/InboundSpeakOrderEnum" }, "outbound_speak_order": { "$ref": "#/components/schemas/OutboundSpeakOrderEnum" }, "voicemail_action": { "$ref": "#/components/schemas/VoicemailActionEnum" }, "voicemail_message": { "type": "string", "description": "Voicemail TTS template. Supported variables: {agent_name}, {org_name}." }, "silence_interval_seconds": { "type": "integer", "maximum": 120, "minimum": 5 }, "silence_max_checkins": { "type": "integer", "maximum": 10, "minimum": 1 }, "silence_checkins_enabled": { "type": "boolean", "description": "Whether the agent proactively checks in and eventually hangs up during caller silence." }, "silence_hangup_seconds": { "type": "integer", "maximum": 3600, "minimum": 60, "description": "Caller-idle seconds before a silent hangup when silence check-ins are disabled." }, "max_call_duration_seconds": { "type": "integer", "maximum": 14400, "minimum": 60, "nullable": true, "description": "Maximum call length in seconds. Null means no limit." }, "ring_duration_seconds": { "type": "integer", "maximum": 120, "minimum": 5, "nullable": true, "description": "Outbound and transfer ringing time in seconds. Null uses platform defaults." }, "connect_tone_enabled": { "type": "boolean", "description": "Whether to play a short connection tone before the agent begins the call." }, "typing_sounds_enabled": { "type": "boolean" }, "play_sound_asset": { "oneOf": [ { "$ref": "#/components/schemas/PlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "speak_uninterruptible_enabled": { "type": "boolean" }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_override": { "$ref": "#/components/schemas/AiLiveProcessingDisclosureOverrideEnum" }, "send_email_enabled": { "type": "boolean", "description": "Whether the agent may send an email to the configured recipient during a call." }, "send_email_recipient": { "type": "string", "format": "email", "maxLength": 254 }, "consent_announcement_enabled": { "type": "boolean" }, "consent_announcement_text": { "type": "string", "minLength": 1 }, "audio_context_mode": { "allOf": [ { "$ref": "#/components/schemas/AudioContextModeEnum" } ], "description": "Storm audio context window. 'reduced' lowers latency by using less prior audio context.\n\n* `full` - Full\n* `reduced` - Reduced" }, "watchdog_enabled": { "type": "boolean" }, "additional_audio_context": { "type": "boolean", "nullable": true, "description": "Override the direction-based depth of recent caller audio included in model context." }, "widget_enabled": { "type": "boolean" }, "split_testing_enabled": { "type": "boolean" }, "draft_name": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_prompt": { "type": "string", "nullable": true }, "draft_voice": { "type": "string", "nullable": true, "maxLength": 100 }, "draft_primary_language": { "type": "string", "nullable": true, "maxLength": 16 }, "draft_native_voice_switching": { "type": "boolean", "nullable": true }, "draft_product": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftProductEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_background_track": { "type": "string", "nullable": true, "maxLength": 255 }, "draft_thinking_level": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftThinkingLevelEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementPromptModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_acknowledgement_prompt": { "type": "string", "nullable": true }, "draft_acknowledgement_feedback_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAcknowledgementFeedbackModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_inbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftInboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_outbound_speak_order": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftOutboundSpeakOrderEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_action": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftVoicemailActionEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_voicemail_message": { "type": "string", "nullable": true }, "draft_silence_interval_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_max_checkins": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_silence_checkins_enabled": { "type": "boolean", "nullable": true }, "draft_silence_hangup_seconds": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true }, "draft_connect_tone_enabled": { "type": "boolean", "nullable": true }, "draft_typing_sounds_enabled": { "type": "boolean", "nullable": true }, "draft_play_sound_asset": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftPlaySoundAssetEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_speak_uninterruptible_enabled": { "type": "boolean", "nullable": true }, "draft_call_recording_enabled": { "type": "boolean", "nullable": true }, "draft_ai_live_processing_disclosure_override": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAiLiveProcessingDisclosureOverrideEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_send_email_enabled": { "type": "boolean", "nullable": true }, "draft_send_email_recipient": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "draft_consent_announcement_enabled": { "type": "boolean", "nullable": true }, "draft_consent_announcement_text": { "type": "string", "nullable": true }, "draft_audio_context_mode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DraftAudioContextModeEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "draft_watchdog_enabled": { "type": "boolean", "nullable": true }, "draft_additional_audio_context": { "type": "boolean", "nullable": true }, "draft_widget_enabled": { "type": "boolean", "nullable": true }, "draft_split_testing_enabled": { "type": "boolean", "nullable": true }, "draft_integration_ids": { "nullable": true }, "draft_knowledge_base_ids": { "nullable": true }, "draft_knowledge_document_ids": { "nullable": true }, "draft_mcp_server_ids": { "nullable": true } } }, "PatchedIntegrationRequest": { "type": "object", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "spec": {}, "endpoint": { "nullable": true }, "wizard_input": { "type": "string" }, "validation_status": { "$ref": "#/components/schemas/ValidationStatusEnum" } } }, "PatchedOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_enabled": { "type": "boolean", "description": "Play the AI/live-processing disclosure on recording-off calls. Recording-on calls are unaffected." } } }, "PatchedOrganizationWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 200 } } }, "PatchedPhoneNumberUpdateRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StatusD47Enum" }, "label": { "type": "string", "description": "Optional friendly name for this number (e.g. 'Main Line', 'Support').", "maxLength": 100 }, "inbound_agent_id": { "type": "integer", "nullable": true }, "outbound_agent_id": { "type": "integer", "nullable": true }, "webhook_url": { "type": "string", "format": "uri", "nullable": true } } }, "PhoneNumber": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "number": { "type": "string", "readOnly": true }, "label": { "type": "string", "readOnly": true, "description": "Optional friendly name for this number (e.g. 'Main Line', 'Support')." }, "source": { "allOf": [ { "$ref": "#/components/schemas/SourceEnum" } ], "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusD47Enum" } ], "readOnly": true }, "inbound_agent_id": { "type": "integer", "readOnly": true, "nullable": true }, "outbound_agent_id": { "type": "integer", "readOnly": true, "nullable": true }, "voip_connection_id": { "type": "integer", "readOnly": true, "nullable": true }, "voip_verification_status": { "allOf": [ { "$ref": "#/components/schemas/VoipVerificationStatusEnum" } ], "readOnly": true }, "voip_last_verified_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "webhook_url": { "type": "string", "readOnly": true }, "webhook_signing_secret": { "type": "string", "readOnly": true } }, "required": [ "id", "inbound_agent_id", "label", "number", "outbound_agent_id", "source", "status", "voip_connection_id", "voip_last_verified_at", "voip_verification_status", "webhook_signing_secret", "webhook_url" ] }, "PhoneNumberUpdate": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StatusD47Enum" }, "label": { "type": "string", "description": "Optional friendly name for this number (e.g. 'Main Line', 'Support').", "maxLength": 100 }, "inbound_agent_id": { "type": "integer", "nullable": true }, "outbound_agent_id": { "type": "integer", "nullable": true }, "webhook_url": { "type": "string", "format": "uri", "nullable": true } } }, "PhoneNumberUpdateRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StatusD47Enum" }, "label": { "type": "string", "description": "Optional friendly name for this number (e.g. 'Main Line', 'Support').", "maxLength": 100 }, "inbound_agent_id": { "type": "integer", "nullable": true }, "outbound_agent_id": { "type": "integer", "nullable": true }, "webhook_url": { "type": "string", "format": "uri", "nullable": true } } }, "PlaySoundAssetEnum": { "enum": [ "chime", "ding", "beep" ], "type": "string", "description": "* `` - None\n* `chime` - Chime\n* `ding` - Ding\n* `beep` - Beep" }, "ProductEnum": { "enum": [ "spark", "bolt", "storm-base", "storm-base-with-ack", "storm-extra", "storm-extra-with-ack" ], "type": "string", "description": "* `spark` - Spark\n* `bolt` - Bolt\n* `storm-base` - Storm Base\n* `storm-base-with-ack` - Storm Base + Ack\n* `storm-extra` - Storm Extra\n* `storm-extra-with-ack` - Storm Extra + Ack" }, "ProviderEnum": { "enum": [ "twilio", "telnyx", "signalwire", "vonage", "manual" ], "type": "string", "description": "* `twilio` - Twilio\n* `telnyx` - Telnyx\n* `signalwire` - SignalWire\n* `vonage` - Vonage\n* `manual` - Manual" }, "SetupMethodEnum": { "enum": [ "api_key", "manual", "guided_telnyx" ], "type": "string", "description": "* `api_key` - API key\n* `manual` - Manual\n* `guided_telnyx` - Guided Telnyx" }, "SourceEnum": { "enum": [ "demo", "voip" ], "type": "string", "description": "* `demo` - ThunderPhone\n* `voip` - VoIP" }, "SourceOriginEnum": { "enum": [ "upload", "url" ], "type": "string", "description": "* `upload` - Upload\n* `url` - Web page" }, "SourceTypeEnum": { "enum": [ "text", "file" ], "type": "string", "description": "* `text` - Text\n* `file` - File" }, "StatusD47Enum": { "enum": [ "provisioning", "active", "failed", "releasing", "released" ], "type": "string", "description": "* `provisioning` - Provisioning\n* `active` - Active\n* `failed` - Failed\n* `releasing` - Releasing\n* `released` - Released" }, "ThinkingLevelEnum": { "enum": [ "base", "extra" ], "type": "string", "description": "* `base` - Base\n* `extra` - Extra" }, "UserOrg": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "readOnly": true }, "call_recording_enabled": { "type": "boolean" }, "ai_live_processing_disclosure_enabled": { "type": "boolean", "description": "Play the AI/live-processing disclosure on recording-off calls. Recording-on calls are unaffected." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "role", "updated_at" ] }, "ValidationStatusEnum": { "enum": [ "untested", "validated", "error" ], "type": "string", "description": "* `untested` - Untested\n* `validated` - Validated\n* `error` - Error" }, "VoicemailActionEnum": { "enum": [ "prompt", "hangup", "message" ], "type": "string", "description": "* `prompt` - Let the agent decide\n* `hangup` - Hang up\n* `message` - Leave a message" }, "VoipConnection": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "provider": { "$ref": "#/components/schemas/ProviderEnum" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VoipConnectionStatusEnum" } ], "readOnly": true }, "setup_method": { "$ref": "#/components/schemas/SetupMethodEnum" }, "inferred_name": { "type": "boolean", "readOnly": true }, "credentials": { "type": "object", "additionalProperties": {}, "readOnly": true }, "sip_config": { "type": "object", "additionalProperties": {}, "readOnly": true }, "test_result": { "readOnly": true }, "last_tested_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "numbers_imported": { "type": "integer", "readOnly": true }, "numbers_pending_verification": { "type": "integer", "description": "Numbers demoted by a routing change and not yet re-proven.", "readOnly": true }, "provisioning_supported": { "type": "boolean", "readOnly": true }, "provisioning_message": { "type": "string", "nullable": true, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "credentials", "id", "inferred_name", "last_tested_at", "name", "numbers_imported", "numbers_pending_verification", "provider", "provisioning_message", "provisioning_supported", "sip_config", "status", "test_result", "updated_at" ] }, "VoipConnectionRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "provider": { "$ref": "#/components/schemas/ProviderEnum" }, "setup_method": { "$ref": "#/components/schemas/SetupMethodEnum" } }, "required": [ "name", "provider" ] }, "VoipConnectionStatusEnum": { "enum": [ "connected", "error", "pending", "testing" ], "type": "string", "description": "* `connected` - Connected\n* `error` - Error\n* `pending` - Pending\n* `testing` - Testing" }, "VoipVerificationStatusEnum": { "enum": [ "unverified", "verified", "carrier_accepted", "failed" ], "type": "string", "description": "* `unverified` - Unverified\n* `verified` - Verified\n* `carrier_accepted` - Carrier accepted\n* `failed` - Failed" } } }, "servers": [ { "url": "https://api.thunderphone.com/v1", "description": "Production" } ] }