On this page
Publish a version
Compile a draft into an immutable version. Set live: false to create a test version; the default makes it live for new runs.
Operation ID: publications.publish.
Request
POST /api/v1/agents/{agent_id}/publications
- TypeScript SDK:
client.publications.publish(path arguments usepath). - MCP tool:
sdk_client_callwithoperationId: "publications.publish"(path arguments useinput.path). Legacy alias:publications_publish. Connect to your authenticated/mcpendpoint with an API key for the same environment. - Minimum API key role: member.
- Idempotency: No header required; the resource or revision identifies the change.
Read resource IDs from earlier responses and use a key for the same environment.
Request example
Replace the draft ID and revision. Version 0 is the first publication; use the next version for later publications. live: false keeps the current live version unchanged.
Set CUMULUS_BASE_URL to your workspace API URL and CUMULUS_API_KEY to a key for that environment. Example values are synthetic.
cURL
curl --fail-with-body -sS -X POST "${CUMULUS_BASE_URL%/}/api/v1/agents/${AGENT_ID}/publications" \
-H "Authorization: Bearer $CUMULUS_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"draft_id": "11111111-1111-4111-8111-111111111111",
"expected_revision": 1,
"version": 0,
"live": false
}'
TypeScript
import { Cumulus } from "@cumulus/sdk";
const baseUrl = process.env.CUMULUS_BASE_URL;
const apiKey = process.env.CUMULUS_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Set CUMULUS_BASE_URL and CUMULUS_API_KEY");
const client = new Cumulus({ baseUrl, apiKey });
const response = await client.publications.publish({
"path": {
"agent_id": "<agent_id>"
},
"body": {
"draft_id": "11111111-1111-4111-8111-111111111111",
"expected_revision": 1,
"version": 0,
"live": false
}
});
Integration notes
Use the version returned by drafts_validate.
live: falsecreates a test publication and keeps the live head unchanged. Run it withtest_runs_create, then promote it withpublications_promote.live: trueis the default and makes the publication live immediately.keep_draft: truekeeps the working draft open for further edits.
Input schema
Path, query and header parameters
agent_id
path parameter · Required.
Type: string. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$.
JSON request body
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
draft_id | string (uuid) | Required | Identifier of the editable draft. Read it from the agent or draft response. pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
expected_revision | integer | Required | Revision you last read. A stale revision is refused so another edit is not overwritten. Greater than 0. At most 2147483647. |
version | integer | Required | At least 0. At most 2147483647. |
live | boolean | Optional | Default: true. |
keep_draft | boolean | Optional | Default: false. |
expected_head_version | integer or null | Optional | Live publication version you last read; null when there is no live version. At least 0. At most 2147483647. |
Complete OpenAPI schema
{
"parameters": [
{
"name": "agent_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationsPublishRequest"
}
}
}
}
}
Responses
HTTP 200
Publish the draft as the next immutable version; moves head unless live is false (201; replay 200)
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
ref | object | Required | — |
ref.agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
ref.version | integer | Required | At least 0. At most 2147483647. |
ref.digest | string | Required | pattern: ^sha256:[a-f0-9]{64}$. |
published_at | string (date-time) | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
published_by | object or null | Required | — |
| published_by · combined section 1 | object | — | Fields for this schema branch. |
| published_by · variant 1 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "user" | Required in a non-null parent | — |
published_by.id | string (uuid) | Required in a non-null parent | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| published_by · variant 2 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "api_key" | Required in a non-null parent | — |
published_by.id | string (uuid) | Required in a non-null parent | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| published_by · variant 3 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "system" | Required in a non-null parent | — |
published_by.id | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
is_head | boolean | Required | — |
test | boolean | Required | — |
plan | object | Required | — |
plan.plan_schema_version | 2 | Required | — |
plan.compiler | object | Required | — |
plan.compiler.name | "talos-compiler" | Required | — |
plan.compiler.version | string | Required | minLength: 1. |
plan.agent | object | Required | — |
plan.agent.agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
plan.agent.version | integer | Required | At least 0. At most 2147483647. |
plan.agent.name | string | Required | minLength: 1. maxLength: 256. |
plan.source | object | Required | — |
plan.source.kind | "studio" · "retell_import" · "api" | Required | — |
plan.source.sha256 | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.channels | object | Required | — |
plan.channels.cloud | object or null | Required | — |
plan.channels.cloud.modes | array of "task" · "chat" · "background" | Required in a non-null parent | minItems: 1. |
plan.channels.cloud.input_schema | object | Required in a non-null parent | — |
plan.channels.cloud.input_schema.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.cloud.output_schema | object | Required in a non-null parent | — |
plan.channels.cloud.output_schema.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.cloud.max_turns | integer | Required in a non-null parent | At least 1. At most 200. |
plan.channels.cloud.idle_timeout_ms | integer | Required in a non-null parent | At least 10000. At most 86400000. |
plan.channels.cloud.deadline_ms | integer | Required in a non-null parent | At least 1000. At most 3600000. |
plan.channels.phone | object or null | Required | — |
plan.channels.phone.telephony | object or null | Required in a non-null parent | — |
plan.channels.phone.telephony.trunk_id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.channels.phone.telephony.from | string or null | Required in a non-null parent | pattern: ^+[1-9][0-9]{6,14}$. |
plan.channels.phone.inbound_context | object | Optional | — |
plan.channels.phone.inbound_context.action_id | string | Required in a non-null parent | pattern: ^[a-z][a-z0-9_]{0,62}$. |
plan.channels.phone.inbound_context.variables | array of string | Required in a non-null parent | minItems: 1. maxItems: 256. |
plan.channels.phone.settings | object | Required in a non-null parent | — |
plan.channels.phone.settings.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.phone.recording | object | Required in a non-null parent | — |
plan.channels.phone.recording.required | boolean | Required in a non-null parent | — |
plan.channels.phone.recording.channels | "dual" | Required in a non-null parent | — |
plan.languages | array of "en" · "es" | Required | minItems: 1. |
plan.flow | object | Required | — |
plan.flow.schemaVersion | 2 | Required | — |
plan.flow.compilerVersion | string | Required | minLength: 1. |
plan.flow.sourceHash | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.id | string | Required | minLength: 1. |
plan.flow.version | integer | Required | At least 0. At most 9007199254740991. |
plan.flow.startNodeId | string | Required | minLength: 1. |
plan.flow.startSpeaker | "agent" · "user" | Required | — |
plan.flow.globalPrompt | string | Required | — |
plan.flow.nodes | array of object | Required | — |
plan.flow.nodes[].id | string | Required | minLength: 1. |
plan.flow.nodes[].kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
plan.flow.nodes[].name | string | Optional | — |
plan.flow.nodes[].instruction | object | Optional | — |
plan.flow.nodes[].instruction.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].instruction.text | string | Required | — |
plan.flow.nodes[].edges | array of object | Required | — |
plan.flow.nodes[].edges[].id | string | Optional | minLength: 1. |
plan.flow.nodes[].edges[].destinationNodeId | string | Optional | minLength: 1. |
plan.flow.nodes[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
plan.flow.nodes[].edges[].condition | object | Required | — |
| plan.flow.nodes[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "always" | Required | — |
| plan.flow.nodes[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "conversation_language" | Required | — |
plan.flow.nodes[].edges[].condition.language | "en" · "es" | Required | — |
| plan.flow.nodes[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "prompt" | Required | — |
plan.flow.nodes[].edges[].condition.prompt | string | Required | — |
| plan.flow.nodes[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "equation" | Required | — |
plan.flow.nodes[].edges[].condition.operator | "&&" · "||" | Required | — |
plan.flow.nodes[].edges[].condition.equations | array of object | Required | minItems: 1. |
plan.flow.nodes[].edges[].condition.equations[].left | string | Required | — |
plan.flow.nodes[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
plan.flow.nodes[].edges[].condition.equations[].right | string | Required | — |
plan.flow.nodes[].edges[].label | string | Optional | — |
plan.flow.nodes[].edges[].compliance | object | Optional | — |
plan.flow.nodes[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
plan.flow.nodes[].startSpeaker | "agent" · "user" | Optional | — |
plan.flow.nodes[].interruptionSensitivity | number | Optional | — |
plan.flow.nodes[].voiceSpeed | number | Optional | — |
plan.flow.nodes[].languageLocked | boolean | Optional | — |
plan.flow.nodes[].globalNodeSetting | object | Optional | — |
plan.flow.nodes[].globalNodeSetting.condition | string | Required | — |
plan.flow.nodes[].globalNodeSetting.coolDown | number | Optional | — |
plan.flow.nodes[].speakDuringExecution | boolean | Optional | — |
plan.flow.nodes[].executionMessage | object | Optional | — |
plan.flow.nodes[].executionMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].executionMessage.text | string | Required | — |
plan.flow.nodes[].toolId | string | Optional | minLength: 1. |
plan.flow.nodes[].waitForResult | boolean | Optional | — |
plan.flow.nodes[].transfer | object | Optional | — |
plan.flow.nodes[].transfer.destination | object | Required | — |
| plan.flow.nodes[].transfer.destination · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].transfer.destination.type | "predefined" | Required | — |
plan.flow.nodes[].transfer.destination.number | string | Required | — |
| plan.flow.nodes[].transfer.destination · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].transfer.destination.type | "inferred" | Required | — |
plan.flow.nodes[].transfer.destination.prompt | string | Required | — |
plan.flow.nodes[].transfer.option | object | Required | — |
plan.flow.nodes[].transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
plan.flow.nodes[].transfer.option.showTransfereeAsCaller | boolean | Optional | — |
plan.flow.nodes[].transfer.option.optOutHumanDetection | boolean | Optional | — |
plan.flow.nodes[].transfer.option.enableBridgeAudioCue | boolean | Optional | — |
plan.flow.nodes[].transfer.option.onHoldMusic | string | Optional | — |
plan.flow.nodes[].transfer.option.agentDetectionTimeoutMs | integer | Optional | At least -9007199254740991. At most 9007199254740991. |
plan.flow.nodes[].transfer.option.agentDetectionPrompt | string | Optional | — |
plan.flow.nodes[].transfer.option.transferMessage | object | Optional | — |
plan.flow.nodes[].transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].transfer.option.transferMessage.text | string | Required | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage | object | Optional | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage.text | string | Required | — |
plan.flow.nodes[].transfer.option.coldTransferMode | string | Optional | — |
plan.flow.nodes[].transfer.customSipHeaders | object | Required | — |
plan.flow.nodes[].transfer.customSipHeaders.* | string | Optional | Additional keys are allowed. |
plan.flow.nodes[].transfer.headerCredential | object | Optional | — |
plan.flow.nodes[].transfer.headerCredential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.nodes[].transfer.headerCredential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.nodes[].transfer.ignoreE164Validation | boolean | Required | — |
plan.flow.nodes[].variables | array of object | Optional | — |
plan.flow.nodes[].variables[].name | string | Required | minLength: 1. |
plan.flow.nodes[].variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
plan.flow.nodes[].variables[].description | string | Required | — |
plan.flow.nodes[].variables[].choices | array of string | Optional | — |
plan.flow.nodes[].modelChoice | object | Optional | — |
plan.flow.nodes[].modelChoice.model | object | Required | — |
plan.flow.nodes[].modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.nodes[].modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.nodes[].modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.nodes[].modelChoice.credential | object | Optional | — |
plan.flow.nodes[].modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.type | "cascading" | Required | — |
plan.flow.nodes[].modelChoice.highPriority | boolean | Required | — |
plan.flow.nodes[].modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.nodes[].verification | object | Optional | — |
plan.flow.nodes[].verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields | array of object | Required | maxItems: 8. |
plan.flow.nodes[].verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
plan.flow.nodes[].verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields[].format | object | Required | — |
| plan.flow.nodes[].verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.fields[].format.kind | "digits" | Required | — |
plan.flow.nodes[].verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| plan.flow.nodes[].verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
plan.flow.nodes[].verification.fields[].prompt | object | Required | — |
plan.flow.nodes[].verification.fields[].prompt.en | string | Required | — |
plan.flow.nodes[].verification.fields[].prompt.es | string | Optional | — |
plan.flow.nodes[].verification.required | object | Required | — |
| plan.flow.nodes[].verification.required · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.required.kind | "fixed" | Required | — |
plan.flow.nodes[].verification.required.count | integer | Required | At least 1. At most 8. |
| plan.flow.nodes[].verification.required · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.required.kind | "variable" | Required | — |
plan.flow.nodes[].verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.nodes[].verification.lookup | object | Optional | — |
plan.flow.nodes[].verification.lookup.toolId | string | Required | minLength: 1. |
plan.flow.nodes[].verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.lookup.arguments | array of object | Required | maxItems: 64. |
plan.flow.nodes[].verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization | object | Optional | — |
plan.flow.nodes[].tokenization.toolId | string | Required | maxLength: 256. |
plan.flow.nodes[].tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.consentPrompt | object | Required | — |
plan.flow.nodes[].tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
plan.flow.nodes[].tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
plan.flow.nodes[].tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.nodes[].tokenization.fields | array of object | Required | maxItems: 7. |
plan.flow.nodes[].tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
plan.flow.nodes[].tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
plan.flow.nodes[].tokenization.fields[].encoding | "string" · "integer" | Required | — |
plan.flow.nodes[].tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
plan.flow.nodes[].tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
plan.flow.nodes[].tokenization.fields[].prompt | object | Required | — |
plan.flow.nodes[].tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
plan.flow.nodes[].tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
plan.flow.nodes[].tokenization.arguments | array of object | Required | maxItems: 64. |
plan.flow.nodes[].tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.arguments[].source | object | Required | — |
| plan.flow.nodes[].tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.arguments[].source.kind | "variable" | Required | — |
plan.flow.nodes[].tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| plan.flow.nodes[].tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.arguments[].source.kind | "constant" | Required | — |
plan.flow.nodes[].tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.last4Field | string | Required | maxLength: 64. |
plan.flow.nodes[].componentId | string | Optional | minLength: 1. |
plan.flow.components | array of object | Required | — |
plan.flow.components[].id | string | Required | minLength: 1. |
plan.flow.components[].startNodeId | string | Required | minLength: 1. |
plan.flow.components[].nodes | array of object | Required | — |
plan.flow.components[].nodes[].id | string | Required | minLength: 1. |
plan.flow.components[].nodes[].kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
plan.flow.components[].nodes[].name | string | Optional | — |
plan.flow.components[].nodes[].instruction | object | Optional | — |
plan.flow.components[].nodes[].instruction.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].instruction.text | string | Required | — |
plan.flow.components[].nodes[].edges | array of object | Required | — |
plan.flow.components[].nodes[].edges[].id | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].edges[].destinationNodeId | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
plan.flow.components[].nodes[].edges[].condition | object | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "always" | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "conversation_language" | Required | — |
plan.flow.components[].nodes[].edges[].condition.language | "en" · "es" | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "prompt" | Required | — |
plan.flow.components[].nodes[].edges[].condition.prompt | string | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "equation" | Required | — |
plan.flow.components[].nodes[].edges[].condition.operator | "&&" · "||" | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations | array of object | Required | minItems: 1. |
plan.flow.components[].nodes[].edges[].condition.equations[].left | string | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations[].right | string | Required | — |
plan.flow.components[].nodes[].edges[].label | string | Optional | — |
plan.flow.components[].nodes[].edges[].compliance | object | Optional | — |
plan.flow.components[].nodes[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
plan.flow.components[].nodes[].startSpeaker | "agent" · "user" | Optional | — |
plan.flow.components[].nodes[].interruptionSensitivity | number | Optional | — |
plan.flow.components[].nodes[].voiceSpeed | number | Optional | — |
plan.flow.components[].nodes[].languageLocked | boolean | Optional | — |
plan.flow.components[].nodes[].globalNodeSetting | object | Optional | — |
plan.flow.components[].nodes[].globalNodeSetting.condition | string | Required | — |
plan.flow.components[].nodes[].globalNodeSetting.coolDown | number | Optional | — |
plan.flow.components[].nodes[].speakDuringExecution | boolean | Optional | — |
plan.flow.components[].nodes[].executionMessage | object | Optional | — |
plan.flow.components[].nodes[].executionMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].executionMessage.text | string | Required | — |
plan.flow.components[].nodes[].toolId | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].waitForResult | boolean | Optional | — |
plan.flow.components[].nodes[].transfer | object | Optional | — |
plan.flow.components[].nodes[].transfer.destination | object | Required | — |
| plan.flow.components[].nodes[].transfer.destination · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].transfer.destination.type | "predefined" | Required | — |
plan.flow.components[].nodes[].transfer.destination.number | string | Required | — |
| plan.flow.components[].nodes[].transfer.destination · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].transfer.destination.type | "inferred" | Required | — |
plan.flow.components[].nodes[].transfer.destination.prompt | string | Required | — |
plan.flow.components[].nodes[].transfer.option | object | Required | — |
plan.flow.components[].nodes[].transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
plan.flow.components[].nodes[].transfer.option.showTransfereeAsCaller | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.optOutHumanDetection | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.enableBridgeAudioCue | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.onHoldMusic | string | Optional | — |
plan.flow.components[].nodes[].transfer.option.agentDetectionTimeoutMs | integer | Optional | At least -9007199254740991. At most 9007199254740991. |
plan.flow.components[].nodes[].transfer.option.agentDetectionPrompt | string | Optional | — |
plan.flow.components[].nodes[].transfer.option.transferMessage | object | Optional | — |
plan.flow.components[].nodes[].transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].transfer.option.transferMessage.text | string | Required | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage | object | Optional | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.text | string | Required | — |
plan.flow.components[].nodes[].transfer.option.coldTransferMode | string | Optional | — |
plan.flow.components[].nodes[].transfer.customSipHeaders | object | Required | — |
plan.flow.components[].nodes[].transfer.customSipHeaders.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].nodes[].transfer.headerCredential | object | Optional | — |
plan.flow.components[].nodes[].transfer.headerCredential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.components[].nodes[].transfer.headerCredential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.components[].nodes[].transfer.ignoreE164Validation | boolean | Required | — |
plan.flow.components[].nodes[].variables | array of object | Optional | — |
plan.flow.components[].nodes[].variables[].name | string | Required | minLength: 1. |
plan.flow.components[].nodes[].variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
plan.flow.components[].nodes[].variables[].description | string | Required | — |
plan.flow.components[].nodes[].variables[].choices | array of string | Optional | — |
plan.flow.components[].nodes[].modelChoice | object | Optional | — |
plan.flow.components[].nodes[].modelChoice.model | object | Required | — |
plan.flow.components[].nodes[].modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.components[].nodes[].modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.components[].nodes[].modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.components[].nodes[].modelChoice.credential | object | Optional | — |
plan.flow.components[].nodes[].modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.type | "cascading" | Required | — |
plan.flow.components[].nodes[].modelChoice.highPriority | boolean | Required | — |
plan.flow.components[].nodes[].modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.components[].nodes[].verification | object | Optional | — |
plan.flow.components[].nodes[].verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields | array of object | Required | maxItems: 8. |
plan.flow.components[].nodes[].verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
plan.flow.components[].nodes[].verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields[].format | object | Required | — |
| plan.flow.components[].nodes[].verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.fields[].format.kind | "digits" | Required | — |
plan.flow.components[].nodes[].verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| plan.flow.components[].nodes[].verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt | object | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt.en | string | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt.es | string | Optional | — |
plan.flow.components[].nodes[].verification.required | object | Required | — |
| plan.flow.components[].nodes[].verification.required · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.required.kind | "fixed" | Required | — |
plan.flow.components[].nodes[].verification.required.count | integer | Required | At least 1. At most 8. |
| plan.flow.components[].nodes[].verification.required · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.required.kind | "variable" | Required | — |
plan.flow.components[].nodes[].verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.components[].nodes[].verification.lookup | object | Optional | — |
plan.flow.components[].nodes[].verification.lookup.toolId | string | Required | minLength: 1. |
plan.flow.components[].nodes[].verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.lookup.arguments | array of object | Required | maxItems: 64. |
plan.flow.components[].nodes[].verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization | object | Optional | — |
plan.flow.components[].nodes[].tokenization.toolId | string | Required | maxLength: 256. |
plan.flow.components[].nodes[].tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.consentPrompt | object | Required | — |
plan.flow.components[].nodes[].tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.components[].nodes[].tokenization.fields | array of object | Required | maxItems: 7. |
plan.flow.components[].nodes[].tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
plan.flow.components[].nodes[].tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
plan.flow.components[].nodes[].tokenization.fields[].encoding | "string" · "integer" | Required | — |
plan.flow.components[].nodes[].tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
plan.flow.components[].nodes[].tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
plan.flow.components[].nodes[].tokenization.fields[].prompt | object | Required | — |
plan.flow.components[].nodes[].tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.arguments | array of object | Required | maxItems: 64. |
plan.flow.components[].nodes[].tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.arguments[].source | object | Required | — |
| plan.flow.components[].nodes[].tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.arguments[].source.kind | "variable" | Required | — |
plan.flow.components[].nodes[].tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| plan.flow.components[].nodes[].tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.arguments[].source.kind | "constant" | Required | — |
plan.flow.components[].nodes[].tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.last4Field | string | Required | maxLength: 64. |
plan.flow.components[].nodes[].componentId | string | Optional | minLength: 1. |
plan.flow.components[].tools | array of object | Required | — |
plan.flow.components[].tools[].id | string | Required | minLength: 1. |
plan.flow.components[].tools[].type | "custom" | Required | — |
plan.flow.components[].tools[].name | string | Required | minLength: 1. |
plan.flow.components[].tools[].description | string | Required | — |
plan.flow.components[].tools[].url | string | Required | — |
plan.flow.components[].tools[].method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
plan.flow.components[].tools[].headers | object | Required | — |
plan.flow.components[].tools[].headers.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].queryParams | object | Required | — |
plan.flow.components[].tools[].queryParams.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].credential | object | Optional | — |
plan.flow.components[].tools[].credential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.components[].tools[].credential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.components[].tools[].parameters | object | Required | — |
plan.flow.components[].tools[].parameters.* | any JSON value | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].responseVariables | object | Required | — |
plan.flow.components[].tools[].responseVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].timeoutMs | integer | Required | At least -9007199254740991. At most 9007199254740991. |
plan.flow.components[].tools[].responseVariablePolicy | "required" · "replace_available" | Optional | — |
plan.flow.components[].tools[].argsAtRoot | boolean | Required | — |
plan.flow.components[].tools[].parameterType | "json" | Required | — |
plan.flow.components[].tools[].speakAfterExecution | boolean | Optional | — |
plan.flow.components[].flexMode | boolean | Optional | — |
plan.flow.tools | array of object | Required | — |
plan.flow.tools[].id | string | Required | minLength: 1. |
plan.flow.tools[].type | "custom" | Required | — |
plan.flow.tools[].name | string | Required | minLength: 1. |
plan.flow.tools[].description | string | Required | — |
plan.flow.tools[].url | string | Required | — |
plan.flow.tools[].method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
plan.flow.tools[].headers | object | Required | — |
plan.flow.tools[].headers.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].queryParams | object | Required | — |
plan.flow.tools[].queryParams.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].credential | object | Optional | — |
plan.flow.tools[].credential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.tools[].credential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.tools[].parameters | object | Required | — |
plan.flow.tools[].parameters.* | any JSON value | Optional | Additional keys are allowed. |
plan.flow.tools[].responseVariables | object | Required | — |
plan.flow.tools[].responseVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].timeoutMs | integer | Required | At least -9007199254740991. At most 9007199254740991. |
plan.flow.tools[].responseVariablePolicy | "required" · "replace_available" | Optional | — |
plan.flow.tools[].argsAtRoot | boolean | Required | — |
plan.flow.tools[].parameterType | "json" | Required | — |
plan.flow.tools[].speakAfterExecution | boolean | Optional | — |
plan.flow.defaultDynamicVariables | object | Required | — |
plan.flow.defaultDynamicVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.callContextVariables | array of string | Optional | — |
plan.flow.modelChoice | object | Optional | — |
plan.flow.modelChoice.model | object | Required | — |
plan.flow.modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.modelChoice.credential | object | Optional | — |
plan.flow.modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.type | "cascading" | Required | — |
plan.flow.modelChoice.highPriority | boolean | Required | — |
plan.flow.modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.toolCallStrictMode | boolean | Required | — |
plan.actions | array of object | Required | — |
plan.actions[].binding_id | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].action | object | Required | — |
plan.actions[].action.id | string | Required | — |
plan.actions[].action.version | integer | Required | Greater than 0. At most 9007199254740991. |
plan.actions[].config | object | Required | — |
plan.actions[].config.* | any JSON value | Optional | Additional keys are allowed. |
plan.actions[].secret_refs | array of object | Required | — |
plan.actions[].secret_refs[].id | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].secret_refs[].version | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].node_ids | array of string | Required | — |
plan.notifications | array of object | Required | — |
plan.notifications[].id | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].url | string (uri) | Required | — |
plan.notifications[].secret_ref | object | Required | — |
plan.notifications[].secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].format | "semantic.v1" | Required | — |
plan.notifications[].events | array of "run.admitted" · "run.ended" · "recording.updated" · "analysis.updated" | Required | minItems: 1. |
plan.knowledge | array of object | Required | — |
plan.knowledge[].pin_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.knowledge[].generation_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.knowledge[].model_identity | object | Required | — |
plan.knowledge[].model_identity.model_id | string | Required | minLength: 1. pattern: \S. |
plan.knowledge[].model_identity.provider | string | Required | minLength: 1. pattern: \S. |
plan.knowledge[].model_identity.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.knowledge[].dimension | integer | Required | Greater than 0. At most 9007199254740991. |
plan.knowledge[].document_ids | array of string (uuid) | Required | minItems: 1. |
plan.knowledge[].documents_sha256 | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.triggers | array of object | Required | — |
| plan.triggers[] · variant 1 | object | — | Fields for this schema branch. |
plan.triggers[].kind | "schedule" | Required | — |
plan.triggers[].id | string | Required | minLength: 1. maxLength: 128. |
plan.triggers[].cron | string | Required | pattern: ^(\S+\s+){4}\S+$. |
plan.triggers[].timezone | string | Required | minLength: 1. maxLength: 64. |
plan.triggers[].input | object | Required | — |
plan.triggers[].input.* | any JSON value | Optional | Additional keys are allowed. |
| plan.triggers[] · variant 2 | object | — | Fields for this schema branch. |
plan.triggers[].kind | "event" | Required | — |
plan.triggers[].id | string | Required | minLength: 1. maxLength: 128. |
plan.triggers[].event_type | "run.ended" · "analysis.updated" | Required | — |
plan.triggers[].source | object | Required | — |
plan.triggers[].source.agent_id | string | Optional | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
plan.triggers[].source.channel | "cloud" · "phone" · "web" | Optional | — |
plan.triggers[].source.dispositions | array of string | Optional | maxItems: 32. |
plan.triggers[].input_mapping | object | Required | — |
plan.triggers[].input_mapping.* | string | Optional | Additional keys are allowed. |
plan.providers | object | Required | — |
plan.providers.llm | object | Required | — |
plan.providers.llm.model | object | Required | — |
plan.providers.llm.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.providers.llm.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.providers.llm.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.providers.llm.route | "platform" · "fleet" · "simulated" | Required | — |
plan.providers.llm.credential | object or null | Required | — |
plan.providers.llm.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.llm.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.llm.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis | object or null | Required | — |
plan.providers.analysis.model | object | Required in a non-null parent | — |
plan.providers.analysis.model.model_id | string | Required in a non-null parent | minLength: 1. pattern: \S. |
plan.providers.analysis.model.provider | string | Required in a non-null parent | minLength: 1. pattern: \S. |
plan.providers.analysis.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required in a non-null parent | — |
plan.providers.analysis.route | "platform" · "fleet" · "simulated" | Required in a non-null parent | — |
plan.providers.analysis.credential | object or null | Required in a non-null parent | — |
plan.providers.analysis.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt | object or null | Required | — |
plan.providers.stt.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt.model | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt.route | "platform" · "fleet" · "simulated" | Required in a non-null parent | — |
plan.providers.stt.languages | array of "en" · "es" | Required in a non-null parent | minItems: 1. |
plan.providers.tts | object or null | Required | — |
plan.providers.tts.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.model | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.voice_id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.route | "platform" · "simulated" | Required in a non-null parent | — |
plan.providers.tts.languages | array of "en" · "es" | Required in a non-null parent | minItems: 1. |
plan.analysis | array of object | Required | — |
plan.analysis[].* | any JSON value | Optional | Additional keys are allowed. |
plan.policy | object | Required | — |
plan.policy.policy_version | string | Required | pattern: ^[a-f0-9]{12}$. |
layout | object | Required | — |
layout.flow | object | Required | — |
layout.flow.nodes | object | Required | — |
layout.flow.nodes.* | object | Optional | Additional keys are allowed. |
layout.flow.start | object | Optional | — |
layout.flow.start.x | number | Required | At least -10000000. At most 10000000. |
layout.flow.start.y | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport | object | Optional | — |
layout.flow.viewport.x | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport.y | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport.zoom | number | Required | At least 0.01. At most 100. |
layout.components | object | Required | — |
layout.components.* | object | Optional | Additional keys are allowed. |
HTTP 201
Publish the draft as the next immutable version; moves head unless live is false (201; replay 200)
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
ref | object | Required | — |
ref.agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
ref.version | integer | Required | At least 0. At most 2147483647. |
ref.digest | string | Required | pattern: ^sha256:[a-f0-9]{64}$. |
published_at | string (date-time) | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
published_by | object or null | Required | — |
| published_by · combined section 1 | object | — | Fields for this schema branch. |
| published_by · variant 1 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "user" | Required in a non-null parent | — |
published_by.id | string (uuid) | Required in a non-null parent | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| published_by · variant 2 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "api_key" | Required in a non-null parent | — |
published_by.id | string (uuid) | Required in a non-null parent | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| published_by · variant 3 | object | — | Fields for this schema branch. |
published_by.owner_id | string | Required in a non-null parent | minLength: 1. |
published_by.environment | string | Required in a non-null parent | minLength: 1. |
published_by.kind | "system" | Required in a non-null parent | — |
published_by.id | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
is_head | boolean | Required | — |
test | boolean | Required | — |
plan | object | Required | — |
plan.plan_schema_version | 2 | Required | — |
plan.compiler | object | Required | — |
plan.compiler.name | "talos-compiler" | Required | — |
plan.compiler.version | string | Required | minLength: 1. |
plan.agent | object | Required | — |
plan.agent.agent_id | string | Required | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
plan.agent.version | integer | Required | At least 0. At most 2147483647. |
plan.agent.name | string | Required | minLength: 1. maxLength: 256. |
plan.source | object | Required | — |
plan.source.kind | "studio" · "retell_import" · "api" | Required | — |
plan.source.sha256 | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.channels | object | Required | — |
plan.channels.cloud | object or null | Required | — |
plan.channels.cloud.modes | array of "task" · "chat" · "background" | Required in a non-null parent | minItems: 1. |
plan.channels.cloud.input_schema | object | Required in a non-null parent | — |
plan.channels.cloud.input_schema.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.cloud.output_schema | object | Required in a non-null parent | — |
plan.channels.cloud.output_schema.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.cloud.max_turns | integer | Required in a non-null parent | At least 1. At most 200. |
plan.channels.cloud.idle_timeout_ms | integer | Required in a non-null parent | At least 10000. At most 86400000. |
plan.channels.cloud.deadline_ms | integer | Required in a non-null parent | At least 1000. At most 3600000. |
plan.channels.phone | object or null | Required | — |
plan.channels.phone.telephony | object or null | Required in a non-null parent | — |
plan.channels.phone.telephony.trunk_id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.channels.phone.telephony.from | string or null | Required in a non-null parent | pattern: ^+[1-9][0-9]{6,14}$. |
plan.channels.phone.inbound_context | object | Optional | — |
plan.channels.phone.inbound_context.action_id | string | Required in a non-null parent | pattern: ^[a-z][a-z0-9_]{0,62}$. |
plan.channels.phone.inbound_context.variables | array of string | Required in a non-null parent | minItems: 1. maxItems: 256. |
plan.channels.phone.settings | object | Required in a non-null parent | — |
plan.channels.phone.settings.* | any JSON value | Optional | Additional keys are allowed. |
plan.channels.phone.recording | object | Required in a non-null parent | — |
plan.channels.phone.recording.required | boolean | Required in a non-null parent | — |
plan.channels.phone.recording.channels | "dual" | Required in a non-null parent | — |
plan.languages | array of "en" · "es" | Required | minItems: 1. |
plan.flow | object | Required | — |
plan.flow.schemaVersion | 2 | Required | — |
plan.flow.compilerVersion | string | Required | minLength: 1. |
plan.flow.sourceHash | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.id | string | Required | minLength: 1. |
plan.flow.version | integer | Required | At least 0. At most 9007199254740991. |
plan.flow.startNodeId | string | Required | minLength: 1. |
plan.flow.startSpeaker | "agent" · "user" | Required | — |
plan.flow.globalPrompt | string | Required | — |
plan.flow.nodes | array of object | Required | — |
plan.flow.nodes[].id | string | Required | minLength: 1. |
plan.flow.nodes[].kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
plan.flow.nodes[].name | string | Optional | — |
plan.flow.nodes[].instruction | object | Optional | — |
plan.flow.nodes[].instruction.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].instruction.text | string | Required | — |
plan.flow.nodes[].edges | array of object | Required | — |
plan.flow.nodes[].edges[].id | string | Optional | minLength: 1. |
plan.flow.nodes[].edges[].destinationNodeId | string | Optional | minLength: 1. |
plan.flow.nodes[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
plan.flow.nodes[].edges[].condition | object | Required | — |
| plan.flow.nodes[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "always" | Required | — |
| plan.flow.nodes[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "conversation_language" | Required | — |
plan.flow.nodes[].edges[].condition.language | "en" · "es" | Required | — |
| plan.flow.nodes[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "prompt" | Required | — |
plan.flow.nodes[].edges[].condition.prompt | string | Required | — |
| plan.flow.nodes[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
plan.flow.nodes[].edges[].condition.type | "equation" | Required | — |
plan.flow.nodes[].edges[].condition.operator | "&&" · "||" | Required | — |
plan.flow.nodes[].edges[].condition.equations | array of object | Required | minItems: 1. |
plan.flow.nodes[].edges[].condition.equations[].left | string | Required | — |
plan.flow.nodes[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
plan.flow.nodes[].edges[].condition.equations[].right | string | Required | — |
plan.flow.nodes[].edges[].label | string | Optional | — |
plan.flow.nodes[].edges[].compliance | object | Optional | — |
plan.flow.nodes[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
plan.flow.nodes[].startSpeaker | "agent" · "user" | Optional | — |
plan.flow.nodes[].interruptionSensitivity | number | Optional | — |
plan.flow.nodes[].voiceSpeed | number | Optional | — |
plan.flow.nodes[].languageLocked | boolean | Optional | — |
plan.flow.nodes[].globalNodeSetting | object | Optional | — |
plan.flow.nodes[].globalNodeSetting.condition | string | Required | — |
plan.flow.nodes[].globalNodeSetting.coolDown | number | Optional | — |
plan.flow.nodes[].speakDuringExecution | boolean | Optional | — |
plan.flow.nodes[].executionMessage | object | Optional | — |
plan.flow.nodes[].executionMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].executionMessage.text | string | Required | — |
plan.flow.nodes[].toolId | string | Optional | minLength: 1. |
plan.flow.nodes[].waitForResult | boolean | Optional | — |
plan.flow.nodes[].transfer | object | Optional | — |
plan.flow.nodes[].transfer.destination | object | Required | — |
| plan.flow.nodes[].transfer.destination · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].transfer.destination.type | "predefined" | Required | — |
plan.flow.nodes[].transfer.destination.number | string | Required | — |
| plan.flow.nodes[].transfer.destination · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].transfer.destination.type | "inferred" | Required | — |
plan.flow.nodes[].transfer.destination.prompt | string | Required | — |
plan.flow.nodes[].transfer.option | object | Required | — |
plan.flow.nodes[].transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
plan.flow.nodes[].transfer.option.showTransfereeAsCaller | boolean | Optional | — |
plan.flow.nodes[].transfer.option.optOutHumanDetection | boolean | Optional | — |
plan.flow.nodes[].transfer.option.enableBridgeAudioCue | boolean | Optional | — |
plan.flow.nodes[].transfer.option.onHoldMusic | string | Optional | — |
plan.flow.nodes[].transfer.option.agentDetectionTimeoutMs | integer | Optional | At least -9007199254740991. At most 9007199254740991. |
plan.flow.nodes[].transfer.option.agentDetectionPrompt | string | Optional | — |
plan.flow.nodes[].transfer.option.transferMessage | object | Optional | — |
plan.flow.nodes[].transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].transfer.option.transferMessage.text | string | Required | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage | object | Optional | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.nodes[].transfer.option.privateHandoffMessage.text | string | Required | — |
plan.flow.nodes[].transfer.option.coldTransferMode | string | Optional | — |
plan.flow.nodes[].transfer.customSipHeaders | object | Required | — |
plan.flow.nodes[].transfer.customSipHeaders.* | string | Optional | Additional keys are allowed. |
plan.flow.nodes[].transfer.headerCredential | object | Optional | — |
plan.flow.nodes[].transfer.headerCredential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.nodes[].transfer.headerCredential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.nodes[].transfer.ignoreE164Validation | boolean | Required | — |
plan.flow.nodes[].variables | array of object | Optional | — |
plan.flow.nodes[].variables[].name | string | Required | minLength: 1. |
plan.flow.nodes[].variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
plan.flow.nodes[].variables[].description | string | Required | — |
plan.flow.nodes[].variables[].choices | array of string | Optional | — |
plan.flow.nodes[].modelChoice | object | Optional | — |
plan.flow.nodes[].modelChoice.model | object | Required | — |
plan.flow.nodes[].modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.nodes[].modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.nodes[].modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.nodes[].modelChoice.credential | object | Optional | — |
plan.flow.nodes[].modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.nodes[].modelChoice.type | "cascading" | Required | — |
plan.flow.nodes[].modelChoice.highPriority | boolean | Required | — |
plan.flow.nodes[].modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.nodes[].verification | object | Optional | — |
plan.flow.nodes[].verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields | array of object | Required | maxItems: 8. |
plan.flow.nodes[].verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
plan.flow.nodes[].verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.fields[].format | object | Required | — |
| plan.flow.nodes[].verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.fields[].format.kind | "digits" | Required | — |
plan.flow.nodes[].verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| plan.flow.nodes[].verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
plan.flow.nodes[].verification.fields[].prompt | object | Required | — |
plan.flow.nodes[].verification.fields[].prompt.en | string | Required | — |
plan.flow.nodes[].verification.fields[].prompt.es | string | Optional | — |
plan.flow.nodes[].verification.required | object | Required | — |
| plan.flow.nodes[].verification.required · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.required.kind | "fixed" | Required | — |
plan.flow.nodes[].verification.required.count | integer | Required | At least 1. At most 8. |
| plan.flow.nodes[].verification.required · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].verification.required.kind | "variable" | Required | — |
plan.flow.nodes[].verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.nodes[].verification.lookup | object | Optional | — |
plan.flow.nodes[].verification.lookup.toolId | string | Required | minLength: 1. |
plan.flow.nodes[].verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.lookup.arguments | array of object | Required | maxItems: 64. |
plan.flow.nodes[].verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization | object | Optional | — |
plan.flow.nodes[].tokenization.toolId | string | Required | maxLength: 256. |
plan.flow.nodes[].tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.consentPrompt | object | Required | — |
plan.flow.nodes[].tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
plan.flow.nodes[].tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
plan.flow.nodes[].tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.nodes[].tokenization.fields | array of object | Required | maxItems: 7. |
plan.flow.nodes[].tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.nodes[].tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
plan.flow.nodes[].tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
plan.flow.nodes[].tokenization.fields[].encoding | "string" · "integer" | Required | — |
plan.flow.nodes[].tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
plan.flow.nodes[].tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
plan.flow.nodes[].tokenization.fields[].prompt | object | Required | — |
plan.flow.nodes[].tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
plan.flow.nodes[].tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
plan.flow.nodes[].tokenization.arguments | array of object | Required | maxItems: 64. |
plan.flow.nodes[].tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.arguments[].source | object | Required | — |
| plan.flow.nodes[].tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.arguments[].source.kind | "variable" | Required | — |
plan.flow.nodes[].tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| plan.flow.nodes[].tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.arguments[].source.kind | "constant" | Required | — |
plan.flow.nodes[].tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| plan.flow.nodes[].tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
plan.flow.nodes[].tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.nodes[].tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.nodes[].tokenization.last4Field | string | Required | maxLength: 64. |
plan.flow.nodes[].componentId | string | Optional | minLength: 1. |
plan.flow.components | array of object | Required | — |
plan.flow.components[].id | string | Required | minLength: 1. |
plan.flow.components[].startNodeId | string | Required | minLength: 1. |
plan.flow.components[].nodes | array of object | Required | — |
plan.flow.components[].nodes[].id | string | Required | minLength: 1. |
plan.flow.components[].nodes[].kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
plan.flow.components[].nodes[].name | string | Optional | — |
plan.flow.components[].nodes[].instruction | object | Optional | — |
plan.flow.components[].nodes[].instruction.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].instruction.text | string | Required | — |
plan.flow.components[].nodes[].edges | array of object | Required | — |
plan.flow.components[].nodes[].edges[].id | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].edges[].destinationNodeId | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
plan.flow.components[].nodes[].edges[].condition | object | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "always" | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "conversation_language" | Required | — |
plan.flow.components[].nodes[].edges[].condition.language | "en" · "es" | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "prompt" | Required | — |
plan.flow.components[].nodes[].edges[].condition.prompt | string | Required | — |
| plan.flow.components[].nodes[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].edges[].condition.type | "equation" | Required | — |
plan.flow.components[].nodes[].edges[].condition.operator | "&&" · "||" | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations | array of object | Required | minItems: 1. |
plan.flow.components[].nodes[].edges[].condition.equations[].left | string | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
plan.flow.components[].nodes[].edges[].condition.equations[].right | string | Required | — |
plan.flow.components[].nodes[].edges[].label | string | Optional | — |
plan.flow.components[].nodes[].edges[].compliance | object | Optional | — |
plan.flow.components[].nodes[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
plan.flow.components[].nodes[].startSpeaker | "agent" · "user" | Optional | — |
plan.flow.components[].nodes[].interruptionSensitivity | number | Optional | — |
plan.flow.components[].nodes[].voiceSpeed | number | Optional | — |
plan.flow.components[].nodes[].languageLocked | boolean | Optional | — |
plan.flow.components[].nodes[].globalNodeSetting | object | Optional | — |
plan.flow.components[].nodes[].globalNodeSetting.condition | string | Required | — |
plan.flow.components[].nodes[].globalNodeSetting.coolDown | number | Optional | — |
plan.flow.components[].nodes[].speakDuringExecution | boolean | Optional | — |
plan.flow.components[].nodes[].executionMessage | object | Optional | — |
plan.flow.components[].nodes[].executionMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].executionMessage.text | string | Required | — |
plan.flow.components[].nodes[].toolId | string | Optional | minLength: 1. |
plan.flow.components[].nodes[].waitForResult | boolean | Optional | — |
plan.flow.components[].nodes[].transfer | object | Optional | — |
plan.flow.components[].nodes[].transfer.destination | object | Required | — |
| plan.flow.components[].nodes[].transfer.destination · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].transfer.destination.type | "predefined" | Required | — |
plan.flow.components[].nodes[].transfer.destination.number | string | Required | — |
| plan.flow.components[].nodes[].transfer.destination · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].transfer.destination.type | "inferred" | Required | — |
plan.flow.components[].nodes[].transfer.destination.prompt | string | Required | — |
plan.flow.components[].nodes[].transfer.option | object | Required | — |
plan.flow.components[].nodes[].transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
plan.flow.components[].nodes[].transfer.option.showTransfereeAsCaller | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.optOutHumanDetection | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.enableBridgeAudioCue | boolean | Optional | — |
plan.flow.components[].nodes[].transfer.option.onHoldMusic | string | Optional | — |
plan.flow.components[].nodes[].transfer.option.agentDetectionTimeoutMs | integer | Optional | At least -9007199254740991. At most 9007199254740991. |
plan.flow.components[].nodes[].transfer.option.agentDetectionPrompt | string | Optional | — |
plan.flow.components[].nodes[].transfer.option.transferMessage | object | Optional | — |
plan.flow.components[].nodes[].transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].transfer.option.transferMessage.text | string | Required | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage | object | Optional | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.text | string | Required | — |
plan.flow.components[].nodes[].transfer.option.coldTransferMode | string | Optional | — |
plan.flow.components[].nodes[].transfer.customSipHeaders | object | Required | — |
plan.flow.components[].nodes[].transfer.customSipHeaders.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].nodes[].transfer.headerCredential | object | Optional | — |
plan.flow.components[].nodes[].transfer.headerCredential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.components[].nodes[].transfer.headerCredential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.components[].nodes[].transfer.ignoreE164Validation | boolean | Required | — |
plan.flow.components[].nodes[].variables | array of object | Optional | — |
plan.flow.components[].nodes[].variables[].name | string | Required | minLength: 1. |
plan.flow.components[].nodes[].variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
plan.flow.components[].nodes[].variables[].description | string | Required | — |
plan.flow.components[].nodes[].variables[].choices | array of string | Optional | — |
plan.flow.components[].nodes[].modelChoice | object | Optional | — |
plan.flow.components[].nodes[].modelChoice.model | object | Required | — |
plan.flow.components[].nodes[].modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.components[].nodes[].modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.components[].nodes[].modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.components[].nodes[].modelChoice.credential | object | Optional | — |
plan.flow.components[].nodes[].modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.components[].nodes[].modelChoice.type | "cascading" | Required | — |
plan.flow.components[].nodes[].modelChoice.highPriority | boolean | Required | — |
plan.flow.components[].nodes[].modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.components[].nodes[].verification | object | Optional | — |
plan.flow.components[].nodes[].verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields | array of object | Required | maxItems: 8. |
plan.flow.components[].nodes[].verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
plan.flow.components[].nodes[].verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.fields[].format | object | Required | — |
| plan.flow.components[].nodes[].verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.fields[].format.kind | "digits" | Required | — |
plan.flow.components[].nodes[].verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| plan.flow.components[].nodes[].verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt | object | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt.en | string | Required | — |
plan.flow.components[].nodes[].verification.fields[].prompt.es | string | Optional | — |
plan.flow.components[].nodes[].verification.required | object | Required | — |
| plan.flow.components[].nodes[].verification.required · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.required.kind | "fixed" | Required | — |
plan.flow.components[].nodes[].verification.required.count | integer | Required | At least 1. At most 8. |
| plan.flow.components[].nodes[].verification.required · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].verification.required.kind | "variable" | Required | — |
plan.flow.components[].nodes[].verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.components[].nodes[].verification.lookup | object | Optional | — |
plan.flow.components[].nodes[].verification.lookup.toolId | string | Required | minLength: 1. |
plan.flow.components[].nodes[].verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.lookup.arguments | array of object | Required | maxItems: 64. |
plan.flow.components[].nodes[].verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization | object | Optional | — |
plan.flow.components[].nodes[].tokenization.toolId | string | Required | maxLength: 256. |
plan.flow.components[].nodes[].tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.consentPrompt | object | Required | — |
plan.flow.components[].nodes[].tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
plan.flow.components[].nodes[].tokenization.fields | array of object | Required | maxItems: 7. |
plan.flow.components[].nodes[].tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
plan.flow.components[].nodes[].tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
plan.flow.components[].nodes[].tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
plan.flow.components[].nodes[].tokenization.fields[].encoding | "string" · "integer" | Required | — |
plan.flow.components[].nodes[].tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
plan.flow.components[].nodes[].tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
plan.flow.components[].nodes[].tokenization.fields[].prompt | object | Required | — |
plan.flow.components[].nodes[].tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
plan.flow.components[].nodes[].tokenization.arguments | array of object | Required | maxItems: 64. |
plan.flow.components[].nodes[].tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.arguments[].source | object | Required | — |
| plan.flow.components[].nodes[].tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.arguments[].source.kind | "variable" | Required | — |
plan.flow.components[].nodes[].tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| plan.flow.components[].nodes[].tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.arguments[].source.kind | "constant" | Required | — |
plan.flow.components[].nodes[].tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
plan.flow.components[].nodes[].tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
plan.flow.components[].nodes[].tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
plan.flow.components[].nodes[].tokenization.last4Field | string | Required | maxLength: 64. |
plan.flow.components[].nodes[].componentId | string | Optional | minLength: 1. |
plan.flow.components[].tools | array of object | Required | — |
plan.flow.components[].tools[].id | string | Required | minLength: 1. |
plan.flow.components[].tools[].type | "custom" | Required | — |
plan.flow.components[].tools[].name | string | Required | minLength: 1. |
plan.flow.components[].tools[].description | string | Required | — |
plan.flow.components[].tools[].url | string | Required | — |
plan.flow.components[].tools[].method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
plan.flow.components[].tools[].headers | object | Required | — |
plan.flow.components[].tools[].headers.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].queryParams | object | Required | — |
plan.flow.components[].tools[].queryParams.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].credential | object | Optional | — |
plan.flow.components[].tools[].credential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.components[].tools[].credential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.components[].tools[].parameters | object | Required | — |
plan.flow.components[].tools[].parameters.* | any JSON value | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].responseVariables | object | Required | — |
plan.flow.components[].tools[].responseVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.components[].tools[].timeoutMs | integer | Required | At least -9007199254740991. At most 9007199254740991. |
plan.flow.components[].tools[].responseVariablePolicy | "required" · "replace_available" | Optional | — |
plan.flow.components[].tools[].argsAtRoot | boolean | Required | — |
plan.flow.components[].tools[].parameterType | "json" | Required | — |
plan.flow.components[].tools[].speakAfterExecution | boolean | Optional | — |
plan.flow.components[].flexMode | boolean | Optional | — |
plan.flow.tools | array of object | Required | — |
plan.flow.tools[].id | string | Required | minLength: 1. |
plan.flow.tools[].type | "custom" | Required | — |
plan.flow.tools[].name | string | Required | minLength: 1. |
plan.flow.tools[].description | string | Required | — |
plan.flow.tools[].url | string | Required | — |
plan.flow.tools[].method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
plan.flow.tools[].headers | object | Required | — |
plan.flow.tools[].headers.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].queryParams | object | Required | — |
plan.flow.tools[].queryParams.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].credential | object | Optional | — |
plan.flow.tools[].credential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.flow.tools[].credential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.flow.tools[].parameters | object | Required | — |
plan.flow.tools[].parameters.* | any JSON value | Optional | Additional keys are allowed. |
plan.flow.tools[].responseVariables | object | Required | — |
plan.flow.tools[].responseVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.tools[].timeoutMs | integer | Required | At least -9007199254740991. At most 9007199254740991. |
plan.flow.tools[].responseVariablePolicy | "required" · "replace_available" | Optional | — |
plan.flow.tools[].argsAtRoot | boolean | Required | — |
plan.flow.tools[].parameterType | "json" | Required | — |
plan.flow.tools[].speakAfterExecution | boolean | Optional | — |
plan.flow.defaultDynamicVariables | object | Required | — |
plan.flow.defaultDynamicVariables.* | string | Optional | Additional keys are allowed. |
plan.flow.callContextVariables | array of string | Optional | — |
plan.flow.modelChoice | object | Optional | — |
plan.flow.modelChoice.model | object | Required | — |
plan.flow.modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.flow.modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.flow.modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.flow.modelChoice.credential | object | Optional | — |
plan.flow.modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
plan.flow.modelChoice.type | "cascading" | Required | — |
plan.flow.modelChoice.highPriority | boolean | Required | — |
plan.flow.modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
plan.flow.toolCallStrictMode | boolean | Required | — |
plan.actions | array of object | Required | — |
plan.actions[].binding_id | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].action | object | Required | — |
plan.actions[].action.id | string | Required | — |
plan.actions[].action.version | integer | Required | Greater than 0. At most 9007199254740991. |
plan.actions[].config | object | Required | — |
plan.actions[].config.* | any JSON value | Optional | Additional keys are allowed. |
plan.actions[].secret_refs | array of object | Required | — |
plan.actions[].secret_refs[].id | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].secret_refs[].version | string | Required | minLength: 1. maxLength: 128. |
plan.actions[].node_ids | array of string | Required | — |
plan.notifications | array of object | Required | — |
plan.notifications[].id | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].url | string (uri) | Required | — |
plan.notifications[].secret_ref | object | Required | — |
plan.notifications[].secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
plan.notifications[].format | "semantic.v1" | Required | — |
plan.notifications[].events | array of "run.admitted" · "run.ended" · "recording.updated" · "analysis.updated" | Required | minItems: 1. |
plan.knowledge | array of object | Required | — |
plan.knowledge[].pin_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.knowledge[].generation_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
plan.knowledge[].model_identity | object | Required | — |
plan.knowledge[].model_identity.model_id | string | Required | minLength: 1. pattern: \S. |
plan.knowledge[].model_identity.provider | string | Required | minLength: 1. pattern: \S. |
plan.knowledge[].model_identity.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.knowledge[].dimension | integer | Required | Greater than 0. At most 9007199254740991. |
plan.knowledge[].document_ids | array of string (uuid) | Required | minItems: 1. |
plan.knowledge[].documents_sha256 | string | Required | pattern: ^[a-f0-9]{64}$. |
plan.triggers | array of object | Required | — |
| plan.triggers[] · variant 1 | object | — | Fields for this schema branch. |
plan.triggers[].kind | "schedule" | Required | — |
plan.triggers[].id | string | Required | minLength: 1. maxLength: 128. |
plan.triggers[].cron | string | Required | pattern: ^(\S+\s+){4}\S+$. |
plan.triggers[].timezone | string | Required | minLength: 1. maxLength: 64. |
plan.triggers[].input | object | Required | — |
plan.triggers[].input.* | any JSON value | Optional | Additional keys are allowed. |
| plan.triggers[] · variant 2 | object | — | Fields for this schema branch. |
plan.triggers[].kind | "event" | Required | — |
plan.triggers[].id | string | Required | minLength: 1. maxLength: 128. |
plan.triggers[].event_type | "run.ended" · "analysis.updated" | Required | — |
plan.triggers[].source | object | Required | — |
plan.triggers[].source.agent_id | string | Optional | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
plan.triggers[].source.channel | "cloud" · "phone" · "web" | Optional | — |
plan.triggers[].source.dispositions | array of string | Optional | maxItems: 32. |
plan.triggers[].input_mapping | object | Required | — |
plan.triggers[].input_mapping.* | string | Optional | Additional keys are allowed. |
plan.providers | object | Required | — |
plan.providers.llm | object | Required | — |
plan.providers.llm.model | object | Required | — |
plan.providers.llm.model.model_id | string | Required | minLength: 1. pattern: \S. |
plan.providers.llm.model.provider | string | Required | minLength: 1. pattern: \S. |
plan.providers.llm.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
plan.providers.llm.route | "platform" · "fleet" · "simulated" | Required | — |
plan.providers.llm.credential | object or null | Required | — |
plan.providers.llm.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.llm.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.llm.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis | object or null | Required | — |
plan.providers.analysis.model | object | Required in a non-null parent | — |
plan.providers.analysis.model.model_id | string | Required in a non-null parent | minLength: 1. pattern: \S. |
plan.providers.analysis.model.provider | string | Required in a non-null parent | minLength: 1. pattern: \S. |
plan.providers.analysis.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required in a non-null parent | — |
plan.providers.analysis.route | "platform" · "fleet" · "simulated" | Required in a non-null parent | — |
plan.providers.analysis.credential | object or null | Required in a non-null parent | — |
plan.providers.analysis.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.analysis.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt | object or null | Required | — |
plan.providers.stt.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt.model | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.stt.route | "platform" · "fleet" · "simulated" | Required in a non-null parent | — |
plan.providers.stt.languages | array of "en" · "es" | Required in a non-null parent | minItems: 1. |
plan.providers.tts | object or null | Required | — |
plan.providers.tts.provider | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.model | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.voice_id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
plan.providers.tts.route | "platform" · "simulated" | Required in a non-null parent | — |
plan.providers.tts.languages | array of "en" · "es" | Required in a non-null parent | minItems: 1. |
plan.analysis | array of object | Required | — |
plan.analysis[].* | any JSON value | Optional | Additional keys are allowed. |
plan.policy | object | Required | — |
plan.policy.policy_version | string | Required | pattern: ^[a-f0-9]{12}$. |
layout | object | Required | — |
layout.flow | object | Required | — |
layout.flow.nodes | object | Required | — |
layout.flow.nodes.* | object | Optional | Additional keys are allowed. |
layout.flow.start | object | Optional | — |
layout.flow.start.x | number | Required | At least -10000000. At most 10000000. |
layout.flow.start.y | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport | object | Optional | — |
layout.flow.viewport.x | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport.y | number | Required | At least -10000000. At most 10000000. |
layout.flow.viewport.zoom | number | Required | At least 0.01. At most 100. |
layout.components | object | Required | — |
layout.components.* | object | Optional | Additional keys are allowed. |
Error responses
| HTTP | Description |
|---|---|
| 4XX | Typed error (ApiError) |
| 5XX | Typed error (ApiError) |
Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.
Complete OpenAPI schema
{
"200": {
"description": "Publish the draft as the next immutable version; moves head unless live is false (201; replay 200)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationsGetResponse200"
}
}
}
},
"201": {
"description": "Publish the draft as the next immutable version; moves head unless live is false (201; replay 200)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationsGetResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
Expand the complete OpenAPI definitions for integrations that generate their own clients.
Complete OpenAPI schema
{
"components": {
"schemas": {
"PublicationsPublishRequest": {
"type": "object",
"properties": {
"draft_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"expected_revision": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 2147483647
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"live": {
"default": true,
"type": "boolean"
},
"keep_draft": {
"default": false,
"type": "boolean"
},
"expected_head_version": {
"nullable": true,
"type": "integer",
"minimum": 0,
"maximum": 2147483647
}
},
"required": [
"draft_id",
"expected_revision",
"version"
],
"additionalProperties": false
},
"PublicationsGetResponse200": {
"type": "object",
"properties": {
"ref": {
"$ref": "#/components/schemas/PublicationRef"
},
"published_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"published_by": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/PrincipalRef"
}
]
},
"is_head": {
"type": "boolean"
},
"test": {
"type": "boolean"
},
"plan": {
"$ref": "#/components/schemas/PublicationPlan"
},
"layout": {
"$ref": "#/components/schemas/AgentLayout"
}
},
"required": [
"ref",
"published_at",
"published_by",
"is_head",
"test",
"plan",
"layout"
],
"additionalProperties": false
},
"PublicationRef": {
"type": "object",
"properties": {
"agent_id": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
}
},
"required": [
"agent_id",
"version",
"digest"
],
"additionalProperties": false
},
"PrincipalRef": {
"oneOf": [
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"user"
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"api_key"
]
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"owner_id": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"system"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"owner_id",
"environment",
"kind",
"id"
],
"additionalProperties": false
}
]
},
"PublicationPlan": {
"type": "object",
"properties": {
"plan_schema_version": {
"type": "number",
"enum": [
2
]
},
"compiler": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"talos-compiler"
]
},
"version": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"version"
],
"additionalProperties": false
},
"agent": {
"type": "object",
"properties": {
"agent_id": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"agent_id",
"version",
"name"
],
"additionalProperties": false
},
"source": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"studio",
"retell_import",
"api"
]
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"kind",
"sha256"
],
"additionalProperties": false
},
"channels": {
"type": "object",
"properties": {
"cloud": {
"nullable": true,
"type": "object",
"properties": {
"modes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"task",
"chat",
"background"
]
}
},
"input_schema": {
"type": "object",
"additionalProperties": {}
},
"output_schema": {
"type": "object",
"additionalProperties": {}
},
"max_turns": {
"type": "integer",
"minimum": 1,
"maximum": 200
},
"idle_timeout_ms": {
"type": "integer",
"minimum": 10000,
"maximum": 86400000
},
"deadline_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 3600000
}
},
"required": [
"modes",
"input_schema",
"output_schema",
"max_turns",
"idle_timeout_ms",
"deadline_ms"
],
"additionalProperties": false
},
"phone": {
"nullable": true,
"type": "object",
"properties": {
"telephony": {
"nullable": true,
"type": "object",
"properties": {
"trunk_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"from": {
"nullable": true,
"type": "string",
"pattern": "^\\+[1-9][0-9]{6,14}$"
}
},
"required": [
"trunk_id",
"from"
],
"additionalProperties": false
},
"inbound_context": {
"type": "object",
"properties": {
"action_id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,62}$"
},
"variables": {
"minItems": 1,
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$"
}
}
},
"required": [
"action_id",
"variables"
],
"additionalProperties": false
},
"settings": {
"type": "object",
"additionalProperties": {}
},
"recording": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"channels": {
"type": "string",
"enum": [
"dual"
]
}
},
"required": [
"required",
"channels"
],
"additionalProperties": false
}
},
"required": [
"telephony",
"settings",
"recording"
],
"additionalProperties": false
}
},
"required": [
"cloud",
"phone"
],
"additionalProperties": false
},
"languages": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"en",
"es"
]
}
},
"flow": {
"$ref": "#/components/schemas/PlanFlow"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"binding_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"config": {
"type": "object",
"additionalProperties": {}
},
"secret_refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"node_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"binding_id",
"action",
"config",
"secret_refs",
"node_ids"
],
"additionalProperties": false
}
},
"notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"url": {
"type": "string",
"format": "uri"
},
"secret_ref": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"format": {
"type": "string",
"enum": [
"semantic.v1"
]
},
"events": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"run.admitted",
"run.ended",
"recording.updated",
"analysis.updated"
]
}
}
},
"required": [
"id",
"url",
"secret_ref",
"format",
"events"
],
"additionalProperties": false
}
},
"knowledge": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pin_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"generation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"model_identity": {
"$ref": "#/components/schemas/ModelIdentity"
},
"dimension": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"document_ids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"documents_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"pin_id",
"generation_id",
"model_identity",
"dimension",
"document_ids",
"documents_sha256"
],
"additionalProperties": false
}
},
"triggers": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"schedule"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"cron": {
"type": "string",
"pattern": "^(\\S+\\s+){4}\\S+$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"input": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"kind",
"id",
"cron",
"timezone",
"input"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"event"
]
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"event_type": {
"type": "string",
"enum": [
"run.ended",
"analysis.updated"
]
},
"source": {
"type": "object",
"properties": {
"agent_id": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$"
},
"channel": {
"type": "string",
"enum": [
"cloud",
"phone",
"web"
]
},
"dispositions": {
"maxItems": 32,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"additionalProperties": false
},
"input_mapping": {
"type": "object",
"additionalProperties": {
"type": "string",
"pattern": "^\\/[A-Za-z0-9_/-]*$"
}
}
},
"required": [
"kind",
"id",
"event_type",
"source",
"input_mapping"
],
"additionalProperties": false
}
]
}
},
"providers": {
"type": "object",
"properties": {
"llm": {
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/ModelIdentity"
},
"route": {
"type": "string",
"enum": [
"platform",
"fleet",
"simulated"
]
},
"credential": {
"nullable": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version",
"provider"
],
"additionalProperties": false
}
},
"required": [
"model",
"route",
"credential"
],
"additionalProperties": false
},
"analysis": {
"nullable": true,
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/ModelIdentity"
},
"route": {
"type": "string",
"enum": [
"platform",
"fleet",
"simulated"
]
},
"credential": {
"nullable": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version",
"provider"
],
"additionalProperties": false
}
},
"required": [
"model",
"route",
"credential"
],
"additionalProperties": false
},
"stt": {
"nullable": true,
"type": "object",
"properties": {
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"route": {
"type": "string",
"enum": [
"platform",
"fleet",
"simulated"
]
},
"languages": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"en",
"es"
]
}
}
},
"required": [
"provider",
"model",
"route",
"languages"
],
"additionalProperties": false
},
"tts": {
"nullable": true,
"type": "object",
"properties": {
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"voice_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"route": {
"type": "string",
"enum": [
"platform",
"simulated"
]
},
"languages": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"en",
"es"
]
}
}
},
"required": [
"provider",
"model",
"voice_id",
"route",
"languages"
],
"additionalProperties": false
}
},
"required": [
"llm",
"analysis",
"stt",
"tts"
],
"additionalProperties": false
},
"analysis": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"policy": {
"type": "object",
"properties": {
"policy_version": {
"type": "string",
"pattern": "^[a-f0-9]{12}$"
}
},
"required": [
"policy_version"
],
"additionalProperties": false
}
},
"required": [
"plan_schema_version",
"compiler",
"agent",
"source",
"channels",
"languages",
"flow",
"actions",
"notifications",
"knowledge",
"triggers",
"providers",
"analysis",
"policy"
],
"additionalProperties": false
},
"PlanFlow": {
"type": "object",
"properties": {
"schemaVersion": {
"type": "number",
"enum": [
2
]
},
"compilerVersion": {
"type": "string",
"minLength": 1
},
"sourceHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"id": {
"type": "string",
"minLength": 1
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"startNodeId": {
"type": "string",
"minLength": 1
},
"startSpeaker": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"globalPrompt": {
"type": "string"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanFlowNode"
}
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"startNodeId": {
"type": "string",
"minLength": 1
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanFlowNode"
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"custom"
]
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"url": {
"type": "string"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"queryParams": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"credential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"version": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"parameters": {
"type": "object",
"additionalProperties": {}
},
"responseVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeoutMs": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"responseVariablePolicy": {
"type": "string",
"enum": [
"required",
"replace_available"
]
},
"argsAtRoot": {
"type": "boolean"
},
"parameterType": {
"type": "string",
"enum": [
"json"
]
},
"speakAfterExecution": {
"type": "boolean"
}
},
"required": [
"id",
"type",
"name",
"description",
"url",
"method",
"headers",
"queryParams",
"parameters",
"responseVariables",
"timeoutMs",
"argsAtRoot",
"parameterType"
],
"additionalProperties": false
}
},
"flexMode": {
"type": "boolean"
}
},
"required": [
"id",
"startNodeId",
"nodes",
"tools"
],
"additionalProperties": false
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"custom"
]
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"url": {
"type": "string"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"queryParams": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"credential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"version": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"parameters": {
"type": "object",
"additionalProperties": {}
},
"responseVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeoutMs": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"responseVariablePolicy": {
"type": "string",
"enum": [
"required",
"replace_available"
]
},
"argsAtRoot": {
"type": "boolean"
},
"parameterType": {
"type": "string",
"enum": [
"json"
]
},
"speakAfterExecution": {
"type": "boolean"
}
},
"required": [
"id",
"type",
"name",
"description",
"url",
"method",
"headers",
"queryParams",
"parameters",
"responseVariables",
"timeoutMs",
"argsAtRoot",
"parameterType"
],
"additionalProperties": false
}
},
"defaultDynamicVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"callContextVariables": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"modelChoice": {
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/ModelIdentity"
},
"credential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"id",
"version",
"provider"
],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"cascading"
]
},
"highPriority": {
"type": "boolean"
},
"reasoningEffort": {
"type": "string",
"enum": [
"low",
"medium",
"high"
]
}
},
"required": [
"model",
"type",
"highPriority"
],
"additionalProperties": false
},
"toolCallStrictMode": {
"type": "boolean"
}
},
"required": [
"schemaVersion",
"compilerVersion",
"sourceHash",
"id",
"version",
"startNodeId",
"startSpeaker",
"globalPrompt",
"nodes",
"components",
"tools",
"defaultDynamicVariables",
"toolCallStrictMode"
],
"additionalProperties": false
},
"PlanFlowNode": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"conversation",
"end",
"branch",
"transfer_call",
"function",
"extract_dynamic_variables",
"verify_identity",
"tokenize_private",
"component"
]
},
"name": {
"type": "string"
},
"instruction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"destinationNodeId": {
"type": "string",
"minLength": 1
},
"slot": {
"type": "string",
"enum": [
"edges",
"else_edge",
"skip_response_edge",
"always_edge",
"edge",
"success_edge"
]
},
"condition": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"always"
]
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"conversation_language"
]
},
"language": {
"type": "string",
"enum": [
"en",
"es"
]
}
},
"required": [
"type",
"language"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt"
]
},
"prompt": {
"type": "string"
}
},
"required": [
"type",
"prompt"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"equation"
]
},
"operator": {
"type": "string",
"enum": [
"&&",
"||"
]
},
"equations": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"==",
"!=",
">",
"<",
">=",
"<=",
"contains",
"is_set",
"is_not_set"
]
},
"right": {
"type": "string"
}
},
"required": [
"left",
"operator",
"right"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"operator",
"equations"
],
"additionalProperties": false
}
]
},
"label": {
"type": "string"
},
"compliance": {
"type": "object",
"properties": {
"sets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"rpc_confirmed"
]
}
}
},
"required": [
"sets"
],
"additionalProperties": false
}
},
"required": [
"slot",
"condition"
],
"additionalProperties": false
}
},
"startSpeaker": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"interruptionSensitivity": {
"type": "number"
},
"voiceSpeed": {
"type": "number"
},
"languageLocked": {
"type": "boolean"
},
"globalNodeSetting": {
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"coolDown": {
"type": "number"
}
},
"required": [
"condition"
],
"additionalProperties": false
},
"speakDuringExecution": {
"type": "boolean"
},
"executionMessage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"toolId": {
"type": "string",
"minLength": 1
},
"waitForResult": {
"type": "boolean"
},
"transfer": {
"type": "object",
"properties": {
"destination": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"predefined"
]
},
"number": {
"type": "string"
}
},
"required": [
"type",
"number"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"inferred"
]
},
"prompt": {
"type": "string"
}
},
"required": [
"type",
"prompt"
],
"additionalProperties": false
}
]
},
"option": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cold_transfer",
"warm_transfer"
]
},
"showTransfereeAsCaller": {
"type": "boolean"
},
"optOutHumanDetection": {
"type": "boolean"
},
"enableBridgeAudioCue": {
"type": "boolean"
},
"onHoldMusic": {
"type": "string"
},
"agentDetectionTimeoutMs": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"agentDetectionPrompt": {
"type": "string"
},
"transferMessage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"privateHandoffMessage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"coldTransferMode": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
"customSipHeaders": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"headerCredential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"version": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"ignoreE164Validation": {
"type": "boolean"
}
},
"required": [
"destination",
"option",
"customSipHeaders",
"ignoreE164Validation"
],
"additionalProperties": false
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean",
"enum"
]
},
"description": {
"type": "string"
},
"choices": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"type",
"description"
],
"additionalProperties": false
}
},
"modelChoice": {
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/ModelIdentity"
},
"credential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"id",
"version",
"provider"
],
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"cascading"
]
},
"highPriority": {
"type": "boolean"
},
"reasoningEffort": {
"type": "string",
"enum": [
"low",
"medium",
"high"
]
}
},
"required": [
"model",
"type",
"highPriority"
],
"additionalProperties": false
},
"verification": {
"type": "object",
"properties": {
"subjectVariable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"fields": {
"maxItems": 8,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"expectedVariable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"privateAliases": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
}
},
"enabledVariable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"format": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"digits"
]
},
"length": {
"type": "integer",
"minimum": 1,
"maximum": 32
}
},
"required": [
"kind",
"length"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"date_yyyymmdd"
]
}
},
"required": [
"kind"
],
"additionalProperties": false
}
]
},
"prompt": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en"
],
"additionalProperties": false
}
},
"required": [
"id",
"expectedVariable",
"enabledVariable",
"format",
"prompt"
],
"additionalProperties": false
}
},
"required": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"fixed"
]
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 8
}
},
"required": [
"kind",
"count"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"variable"
]
},
"name": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
}
},
"required": [
"kind",
"name"
],
"additionalProperties": false
}
]
},
"timeoutMs": {
"type": "integer",
"minimum": 1000,
"maximum": 180000
},
"lookup": {
"type": "object",
"properties": {
"toolId": {
"type": "string",
"minLength": 1
},
"fieldId": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"parameter": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"arguments": {
"maxItems": 64,
"type": "array",
"items": {
"type": "object",
"properties": {
"parameter": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,255}$"
}
},
"required": [
"parameter",
"variable"
],
"additionalProperties": false
}
}
},
"required": [
"toolId",
"fieldId",
"parameter",
"arguments"
],
"additionalProperties": false
}
},
"required": [
"subjectVariable",
"fields",
"required",
"timeoutMs"
],
"additionalProperties": false
},
"tokenization": {
"type": "object",
"properties": {
"toolId": {
"type": "string",
"maxLength": 256
},
"subjectVariable": {
"type": "string",
"pattern": "^(?!(?:__proto__|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"consentPrompt": {
"type": "object",
"properties": {
"en": {
"type": "string",
"maxLength": 4096
},
"es": {
"type": "string",
"maxLength": 4096
}
},
"required": [
"en"
],
"additionalProperties": false
},
"timeoutMs": {
"type": "integer",
"minimum": 1000,
"maximum": 180000
},
"fields": {
"maxItems": 7,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"parameter": {
"type": "string",
"maxLength": 256,
"pattern": "^(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*(?:\\.(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*){0,7}$"
},
"minDigits": {
"type": "integer",
"minimum": 1,
"maximum": 32
},
"maxDigits": {
"type": "integer",
"minimum": 1,
"maximum": 32
},
"encoding": {
"type": "string",
"enum": [
"string",
"integer"
]
},
"minimum": {
"type": "integer",
"minimum": 0,
"maximum": 999999999
},
"maximum": {
"type": "integer",
"minimum": 0,
"maximum": 999999999
},
"prompt": {
"type": "object",
"properties": {
"en": {
"type": "string",
"maxLength": 4096
},
"es": {
"type": "string",
"maxLength": 4096
}
},
"required": [
"en"
],
"additionalProperties": false
}
},
"required": [
"id",
"parameter",
"minDigits",
"maxDigits",
"encoding",
"prompt"
],
"additionalProperties": false
}
},
"arguments": {
"maxItems": 64,
"type": "array",
"items": {
"type": "object",
"properties": {
"parameter": {
"type": "string",
"maxLength": 256,
"pattern": "^(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*(?:\\.(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*){0,7}$"
},
"source": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"variable"
]
},
"name": {
"type": "string",
"pattern": "^(?!(?:__proto__|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$"
}
},
"required": [
"kind",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"constant"
]
},
"value": {
"nullable": true,
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"kind",
"value"
],
"additionalProperties": false
}
]
}
},
"required": [
"parameter",
"source"
],
"additionalProperties": false
}
},
"tokenIdPath": {
"type": "string",
"maxLength": 256,
"pattern": "^(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*(?:\\.(?!(?:__proto__|constructor|prototype)(?:\\.|$))[A-Za-z_][A-Za-z0-9_]*){0,7}$"
},
"tokenVariable": {
"type": "string",
"pattern": "^(?!(?:__proto__|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"last4Variable": {
"type": "string",
"pattern": "^(?!(?:__proto__|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$"
},
"last4Field": {
"type": "string",
"maxLength": 64
}
},
"required": [
"toolId",
"subjectVariable",
"consentPrompt",
"timeoutMs",
"fields",
"arguments",
"tokenIdPath",
"tokenVariable",
"last4Variable",
"last4Field"
],
"additionalProperties": false
},
"componentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"kind",
"edges"
],
"additionalProperties": false
},
"ModelIdentity": {
"type": "object",
"properties": {
"model_id": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"provider": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"tier": {
"type": "string",
"enum": [
"frontier",
"cumulus-served",
"customer-gpu"
]
}
},
"required": [
"model_id",
"provider",
"tier"
],
"additionalProperties": false
},
"AgentLayout": {
"type": "object",
"properties": {
"flow": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
}
},
"start": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
"viewport": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"zoom": {
"type": "number",
"minimum": 0.01,
"maximum": 100
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
}
},
"required": [
"nodes"
],
"additionalProperties": false
},
"components": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"nodes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
}
},
"start": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
"viewport": {
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"zoom": {
"type": "number",
"minimum": 0.01,
"maximum": 100
}
},
"required": [
"x",
"y",
"zoom"
],
"additionalProperties": false
}
},
"required": [
"nodes"
],
"additionalProperties": false
}
}
},
"required": [
"flow",
"components"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.