CumulusDocs
Open Studio
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 use path).
  • MCP tool: sdk_client_call with operationId: "publications.publish" (path arguments use input.path). Legacy alias: publications_publish. Connect to your authenticated /mcp endpoint 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
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

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: false creates a test publication and keeps the live head unchanged. Run it with test_runs_create, then promote it with publications_promote.
  • live: true is the default and makes the publication live immediately.
  • keep_draft: true keeps 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

FieldType or valuesRequiredDescription and limits
draft_idstring (uuid)RequiredIdentifier 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_revisionintegerRequiredRevision you last read. A stale revision is refused so another edit is not overwritten. Greater than 0. At most 2147483647.
versionintegerRequiredAt least 0. At most 2147483647.
livebooleanOptionalDefault: true.
keep_draftbooleanOptionalDefault: false.
expected_head_versioninteger or nullOptionalLive publication version you last read; null when there is no live version. At least 0. At most 2147483647.
Complete OpenAPI schema
OpenAPI JSON
{
  "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

FieldType or valuesRequiredDescription and limits
refobjectRequired—
ref.agent_idstringRequiredAgent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$.
ref.versionintegerRequiredAt least 0. At most 2147483647.
ref.digeststringRequiredpattern: ^sha256:[a-f0-9]{64}$.
published_atstring (date-time)Requiredpattern: ^(?:(?:\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_byobject or nullRequired—
published_by · combined section 1object—Fields for this schema branch.
published_by · variant 1object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"user"Required in a non-null parent—
published_by.idstring (uuid)Required in a non-null parentpattern: ^([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 2object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"api_key"Required in a non-null parent—
published_by.idstring (uuid)Required in a non-null parentpattern: ^([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 3object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"system"Required in a non-null parent—
published_by.idstringRequired in a non-null parentminLength: 1. maxLength: 256.
is_headbooleanRequired—
testbooleanRequired—
planobjectRequired—
plan.plan_schema_version2Required—
plan.compilerobjectRequired—
plan.compiler.name"talos-compiler"Required—
plan.compiler.versionstringRequiredminLength: 1.
plan.agentobjectRequired—
plan.agent.agent_idstringRequiredAgent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$.
plan.agent.versionintegerRequiredAt least 0. At most 2147483647.
plan.agent.namestringRequiredminLength: 1. maxLength: 256.
plan.sourceobjectRequired—
plan.source.kind"studio" · "retell_import" · "api"Required—
plan.source.sha256stringRequiredpattern: ^[a-f0-9]{64}$.
plan.channelsobjectRequired—
plan.channels.cloudobject or nullRequired—
plan.channels.cloud.modesarray of "task" · "chat" · "background"Required in a non-null parentminItems: 1.
plan.channels.cloud.input_schemaobjectRequired in a non-null parent—
plan.channels.cloud.input_schema.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.cloud.output_schemaobjectRequired in a non-null parent—
plan.channels.cloud.output_schema.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.cloud.max_turnsintegerRequired in a non-null parentAt least 1. At most 200.
plan.channels.cloud.idle_timeout_msintegerRequired in a non-null parentAt least 10000. At most 86400000.
plan.channels.cloud.deadline_msintegerRequired in a non-null parentAt least 1000. At most 3600000.
plan.channels.phoneobject or nullRequired—
plan.channels.phone.telephonyobject or nullRequired in a non-null parent—
plan.channels.phone.telephony.trunk_idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.channels.phone.telephony.fromstring or nullRequired in a non-null parentpattern: ^+[1-9][0-9]{6,14}$.
plan.channels.phone.inbound_contextobjectOptional—
plan.channels.phone.inbound_context.action_idstringRequired in a non-null parentpattern: ^[a-z][a-z0-9_]{0,62}$.
plan.channels.phone.inbound_context.variablesarray of stringRequired in a non-null parentminItems: 1. maxItems: 256.
plan.channels.phone.settingsobjectRequired in a non-null parent—
plan.channels.phone.settings.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.phone.recordingobjectRequired in a non-null parent—
plan.channels.phone.recording.requiredbooleanRequired in a non-null parent—
plan.channels.phone.recording.channels"dual"Required in a non-null parent—
plan.languagesarray of "en" · "es"RequiredminItems: 1.
plan.flowobjectRequired—
plan.flow.schemaVersion2Required—
plan.flow.compilerVersionstringRequiredminLength: 1.
plan.flow.sourceHashstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.idstringRequiredminLength: 1.
plan.flow.versionintegerRequiredAt least 0. At most 9007199254740991.
plan.flow.startNodeIdstringRequiredminLength: 1.
plan.flow.startSpeaker"agent" · "user"Required—
plan.flow.globalPromptstringRequired—
plan.flow.nodesarray of objectRequired—
plan.flow.nodes[].idstringRequiredminLength: 1.
plan.flow.nodes[].kind"conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component"Required—
plan.flow.nodes[].namestringOptional—
plan.flow.nodes[].instructionobjectOptional—
plan.flow.nodes[].instruction.type"prompt" · "static_text"Required—
plan.flow.nodes[].instruction.textstringRequired—
plan.flow.nodes[].edgesarray of objectRequired—
plan.flow.nodes[].edges[].idstringOptionalminLength: 1.
plan.flow.nodes[].edges[].destinationNodeIdstringOptionalminLength: 1.
plan.flow.nodes[].edges[].slot"edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge"Required—
plan.flow.nodes[].edges[].conditionobjectRequired—
plan.flow.nodes[].edges[].condition · variant 1object—Fields for this schema branch.
plan.flow.nodes[].edges[].condition.type"always"Required—
plan.flow.nodes[].edges[].condition · variant 2object—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 3object—Fields for this schema branch.
plan.flow.nodes[].edges[].condition.type"prompt"Required—
plan.flow.nodes[].edges[].condition.promptstringRequired—
plan.flow.nodes[].edges[].condition · variant 4object—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.equationsarray of objectRequiredminItems: 1.
plan.flow.nodes[].edges[].condition.equations[].leftstringRequired—
plan.flow.nodes[].edges[].condition.equations[].operator"==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set"Required—
plan.flow.nodes[].edges[].condition.equations[].rightstringRequired—
plan.flow.nodes[].edges[].labelstringOptional—
plan.flow.nodes[].edges[].complianceobjectOptional—
plan.flow.nodes[].edges[].compliance.setsarray of "rpc_confirmed"RequiredminItems: 1.
plan.flow.nodes[].startSpeaker"agent" · "user"Optional—
plan.flow.nodes[].interruptionSensitivitynumberOptional—
plan.flow.nodes[].voiceSpeednumberOptional—
plan.flow.nodes[].languageLockedbooleanOptional—
plan.flow.nodes[].globalNodeSettingobjectOptional—
plan.flow.nodes[].globalNodeSetting.conditionstringRequired—
plan.flow.nodes[].globalNodeSetting.coolDownnumberOptional—
plan.flow.nodes[].speakDuringExecutionbooleanOptional—
plan.flow.nodes[].executionMessageobjectOptional—
plan.flow.nodes[].executionMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].executionMessage.textstringRequired—
plan.flow.nodes[].toolIdstringOptionalminLength: 1.
plan.flow.nodes[].waitForResultbooleanOptional—
plan.flow.nodes[].transferobjectOptional—
plan.flow.nodes[].transfer.destinationobjectRequired—
plan.flow.nodes[].transfer.destination · variant 1object—Fields for this schema branch.
plan.flow.nodes[].transfer.destination.type"predefined"Required—
plan.flow.nodes[].transfer.destination.numberstringRequired—
plan.flow.nodes[].transfer.destination · variant 2object—Fields for this schema branch.
plan.flow.nodes[].transfer.destination.type"inferred"Required—
plan.flow.nodes[].transfer.destination.promptstringRequired—
plan.flow.nodes[].transfer.optionobjectRequired—
plan.flow.nodes[].transfer.option.type"cold_transfer" · "warm_transfer"Required—
plan.flow.nodes[].transfer.option.showTransfereeAsCallerbooleanOptional—
plan.flow.nodes[].transfer.option.optOutHumanDetectionbooleanOptional—
plan.flow.nodes[].transfer.option.enableBridgeAudioCuebooleanOptional—
plan.flow.nodes[].transfer.option.onHoldMusicstringOptional—
plan.flow.nodes[].transfer.option.agentDetectionTimeoutMsintegerOptionalAt least -9007199254740991. At most 9007199254740991.
plan.flow.nodes[].transfer.option.agentDetectionPromptstringOptional—
plan.flow.nodes[].transfer.option.transferMessageobjectOptional—
plan.flow.nodes[].transfer.option.transferMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].transfer.option.transferMessage.textstringRequired—
plan.flow.nodes[].transfer.option.privateHandoffMessageobjectOptional—
plan.flow.nodes[].transfer.option.privateHandoffMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].transfer.option.privateHandoffMessage.textstringRequired—
plan.flow.nodes[].transfer.option.coldTransferModestringOptional—
plan.flow.nodes[].transfer.customSipHeadersobjectRequired—
plan.flow.nodes[].transfer.customSipHeaders.*stringOptionalAdditional keys are allowed.
plan.flow.nodes[].transfer.headerCredentialobjectOptional—
plan.flow.nodes[].transfer.headerCredential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.nodes[].transfer.ignoreE164ValidationbooleanRequired—
plan.flow.nodes[].variablesarray of objectOptional—
plan.flow.nodes[].variables[].namestringRequiredminLength: 1.
plan.flow.nodes[].variables[].type"string" · "number" · "boolean" · "enum"Required—
plan.flow.nodes[].variables[].descriptionstringRequired—
plan.flow.nodes[].variables[].choicesarray of stringOptional—
plan.flow.nodes[].modelChoiceobjectOptional—
plan.flow.nodes[].modelChoice.modelobjectRequired—
plan.flow.nodes[].modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.nodes[].modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.nodes[].modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.nodes[].modelChoice.credentialobjectOptional—
plan.flow.nodes[].modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.type"cascading"Required—
plan.flow.nodes[].modelChoice.highPrioritybooleanRequired—
plan.flow.nodes[].modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.nodes[].verificationobjectOptional—
plan.flow.nodes[].verification.subjectVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fieldsarray of objectRequiredmaxItems: 8.
plan.flow.nodes[].verification.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].verification.fields[].expectedVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fields[].privateAliasesarray of stringOptionalmaxItems: 16.
plan.flow.nodes[].verification.fields[].enabledVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fields[].formatobjectRequired—
plan.flow.nodes[].verification.fields[].format · variant 1object—Fields for this schema branch.
plan.flow.nodes[].verification.fields[].format.kind"digits"Required—
plan.flow.nodes[].verification.fields[].format.lengthintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].verification.fields[].format · variant 2object—Fields for this schema branch.
plan.flow.nodes[].verification.fields[].format.kind"date_yyyymmdd"Required—
plan.flow.nodes[].verification.fields[].promptobjectRequired—
plan.flow.nodes[].verification.fields[].prompt.enstringRequired—
plan.flow.nodes[].verification.fields[].prompt.esstringOptional—
plan.flow.nodes[].verification.requiredobjectRequired—
plan.flow.nodes[].verification.required · variant 1object—Fields for this schema branch.
plan.flow.nodes[].verification.required.kind"fixed"Required—
plan.flow.nodes[].verification.required.countintegerRequiredAt least 1. At most 8.
plan.flow.nodes[].verification.required · variant 2object—Fields for this schema branch.
plan.flow.nodes[].verification.required.kind"variable"Required—
plan.flow.nodes[].verification.required.namestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.nodes[].verification.lookupobjectOptional—
plan.flow.nodes[].verification.lookup.toolIdstringRequiredminLength: 1.
plan.flow.nodes[].verification.lookup.fieldIdstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].verification.lookup.parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.lookup.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.nodes[].verification.lookup.arguments[].parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.lookup.arguments[].variablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenizationobjectOptional—
plan.flow.nodes[].tokenization.toolIdstringRequiredmaxLength: 256.
plan.flow.nodes[].tokenization.subjectVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.consentPromptobjectRequired—
plan.flow.nodes[].tokenization.consentPrompt.enstringRequiredmaxLength: 4096.
plan.flow.nodes[].tokenization.consentPrompt.esstringOptionalmaxLength: 4096.
plan.flow.nodes[].tokenization.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.nodes[].tokenization.fieldsarray of objectRequiredmaxItems: 7.
plan.flow.nodes[].tokenization.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].tokenization.fields[].parameterstringRequiredmaxLength: 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[].minDigitsintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].tokenization.fields[].maxDigitsintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].tokenization.fields[].encoding"string" · "integer"Required—
plan.flow.nodes[].tokenization.fields[].minimumintegerOptionalAt least 0. At most 999999999.
plan.flow.nodes[].tokenization.fields[].maximumintegerOptionalAt least 0. At most 999999999.
plan.flow.nodes[].tokenization.fields[].promptobjectRequired—
plan.flow.nodes[].tokenization.fields[].prompt.enstringRequiredmaxLength: 4096.
plan.flow.nodes[].tokenization.fields[].prompt.esstringOptionalmaxLength: 4096.
plan.flow.nodes[].tokenization.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.nodes[].tokenization.arguments[].parameterstringRequiredmaxLength: 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[].sourceobjectRequired—
plan.flow.nodes[].tokenization.arguments[].source · variant 1object—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.kind"variable"Required—
plan.flow.nodes[].tokenization.arguments[].source.namestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.arguments[].source · variant 2object—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.kind"constant"Required—
plan.flow.nodes[].tokenization.arguments[].source.valuestring or number or boolean or nullRequired—
plan.flow.nodes[].tokenization.arguments[].source.value · variant 1string—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.value · variant 2number—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.value · variant 3boolean—Fields for this schema branch.
plan.flow.nodes[].tokenization.tokenIdPathstringRequiredmaxLength: 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.tokenVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.last4VariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.last4FieldstringRequiredmaxLength: 64.
plan.flow.nodes[].componentIdstringOptionalminLength: 1.
plan.flow.componentsarray of objectRequired—
plan.flow.components[].idstringRequiredminLength: 1.
plan.flow.components[].startNodeIdstringRequiredminLength: 1.
plan.flow.components[].nodesarray of objectRequired—
plan.flow.components[].nodes[].idstringRequiredminLength: 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[].namestringOptional—
plan.flow.components[].nodes[].instructionobjectOptional—
plan.flow.components[].nodes[].instruction.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].instruction.textstringRequired—
plan.flow.components[].nodes[].edgesarray of objectRequired—
plan.flow.components[].nodes[].edges[].idstringOptionalminLength: 1.
plan.flow.components[].nodes[].edges[].destinationNodeIdstringOptionalminLength: 1.
plan.flow.components[].nodes[].edges[].slot"edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge"Required—
plan.flow.components[].nodes[].edges[].conditionobjectRequired—
plan.flow.components[].nodes[].edges[].condition · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].edges[].condition.type"always"Required—
plan.flow.components[].nodes[].edges[].condition · variant 2object—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 3object—Fields for this schema branch.
plan.flow.components[].nodes[].edges[].condition.type"prompt"Required—
plan.flow.components[].nodes[].edges[].condition.promptstringRequired—
plan.flow.components[].nodes[].edges[].condition · variant 4object—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.equationsarray of objectRequiredminItems: 1.
plan.flow.components[].nodes[].edges[].condition.equations[].leftstringRequired—
plan.flow.components[].nodes[].edges[].condition.equations[].operator"==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set"Required—
plan.flow.components[].nodes[].edges[].condition.equations[].rightstringRequired—
plan.flow.components[].nodes[].edges[].labelstringOptional—
plan.flow.components[].nodes[].edges[].complianceobjectOptional—
plan.flow.components[].nodes[].edges[].compliance.setsarray of "rpc_confirmed"RequiredminItems: 1.
plan.flow.components[].nodes[].startSpeaker"agent" · "user"Optional—
plan.flow.components[].nodes[].interruptionSensitivitynumberOptional—
plan.flow.components[].nodes[].voiceSpeednumberOptional—
plan.flow.components[].nodes[].languageLockedbooleanOptional—
plan.flow.components[].nodes[].globalNodeSettingobjectOptional—
plan.flow.components[].nodes[].globalNodeSetting.conditionstringRequired—
plan.flow.components[].nodes[].globalNodeSetting.coolDownnumberOptional—
plan.flow.components[].nodes[].speakDuringExecutionbooleanOptional—
plan.flow.components[].nodes[].executionMessageobjectOptional—
plan.flow.components[].nodes[].executionMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].executionMessage.textstringRequired—
plan.flow.components[].nodes[].toolIdstringOptionalminLength: 1.
plan.flow.components[].nodes[].waitForResultbooleanOptional—
plan.flow.components[].nodes[].transferobjectOptional—
plan.flow.components[].nodes[].transfer.destinationobjectRequired—
plan.flow.components[].nodes[].transfer.destination · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].transfer.destination.type"predefined"Required—
plan.flow.components[].nodes[].transfer.destination.numberstringRequired—
plan.flow.components[].nodes[].transfer.destination · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].transfer.destination.type"inferred"Required—
plan.flow.components[].nodes[].transfer.destination.promptstringRequired—
plan.flow.components[].nodes[].transfer.optionobjectRequired—
plan.flow.components[].nodes[].transfer.option.type"cold_transfer" · "warm_transfer"Required—
plan.flow.components[].nodes[].transfer.option.showTransfereeAsCallerbooleanOptional—
plan.flow.components[].nodes[].transfer.option.optOutHumanDetectionbooleanOptional—
plan.flow.components[].nodes[].transfer.option.enableBridgeAudioCuebooleanOptional—
plan.flow.components[].nodes[].transfer.option.onHoldMusicstringOptional—
plan.flow.components[].nodes[].transfer.option.agentDetectionTimeoutMsintegerOptionalAt least -9007199254740991. At most 9007199254740991.
plan.flow.components[].nodes[].transfer.option.agentDetectionPromptstringOptional—
plan.flow.components[].nodes[].transfer.option.transferMessageobjectOptional—
plan.flow.components[].nodes[].transfer.option.transferMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].transfer.option.transferMessage.textstringRequired—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessageobjectOptional—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.textstringRequired—
plan.flow.components[].nodes[].transfer.option.coldTransferModestringOptional—
plan.flow.components[].nodes[].transfer.customSipHeadersobjectRequired—
plan.flow.components[].nodes[].transfer.customSipHeaders.*stringOptionalAdditional keys are allowed.
plan.flow.components[].nodes[].transfer.headerCredentialobjectOptional—
plan.flow.components[].nodes[].transfer.headerCredential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.components[].nodes[].transfer.ignoreE164ValidationbooleanRequired—
plan.flow.components[].nodes[].variablesarray of objectOptional—
plan.flow.components[].nodes[].variables[].namestringRequiredminLength: 1.
plan.flow.components[].nodes[].variables[].type"string" · "number" · "boolean" · "enum"Required—
plan.flow.components[].nodes[].variables[].descriptionstringRequired—
plan.flow.components[].nodes[].variables[].choicesarray of stringOptional—
plan.flow.components[].nodes[].modelChoiceobjectOptional—
plan.flow.components[].nodes[].modelChoice.modelobjectRequired—
plan.flow.components[].nodes[].modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.components[].nodes[].modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.components[].nodes[].modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.components[].nodes[].modelChoice.credentialobjectOptional—
plan.flow.components[].nodes[].modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.type"cascading"Required—
plan.flow.components[].nodes[].modelChoice.highPrioritybooleanRequired—
plan.flow.components[].nodes[].modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.components[].nodes[].verificationobjectOptional—
plan.flow.components[].nodes[].verification.subjectVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fieldsarray of objectRequiredmaxItems: 8.
plan.flow.components[].nodes[].verification.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].verification.fields[].expectedVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fields[].privateAliasesarray of stringOptionalmaxItems: 16.
plan.flow.components[].nodes[].verification.fields[].enabledVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fields[].formatobjectRequired—
plan.flow.components[].nodes[].verification.fields[].format · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.fields[].format.kind"digits"Required—
plan.flow.components[].nodes[].verification.fields[].format.lengthintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].verification.fields[].format · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.fields[].format.kind"date_yyyymmdd"Required—
plan.flow.components[].nodes[].verification.fields[].promptobjectRequired—
plan.flow.components[].nodes[].verification.fields[].prompt.enstringRequired—
plan.flow.components[].nodes[].verification.fields[].prompt.esstringOptional—
plan.flow.components[].nodes[].verification.requiredobjectRequired—
plan.flow.components[].nodes[].verification.required · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.required.kind"fixed"Required—
plan.flow.components[].nodes[].verification.required.countintegerRequiredAt least 1. At most 8.
plan.flow.components[].nodes[].verification.required · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.required.kind"variable"Required—
plan.flow.components[].nodes[].verification.required.namestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.components[].nodes[].verification.lookupobjectOptional—
plan.flow.components[].nodes[].verification.lookup.toolIdstringRequiredminLength: 1.
plan.flow.components[].nodes[].verification.lookup.fieldIdstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].verification.lookup.parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.lookup.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.components[].nodes[].verification.lookup.arguments[].parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.lookup.arguments[].variablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenizationobjectOptional—
plan.flow.components[].nodes[].tokenization.toolIdstringRequiredmaxLength: 256.
plan.flow.components[].nodes[].tokenization.subjectVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.consentPromptobjectRequired—
plan.flow.components[].nodes[].tokenization.consentPrompt.enstringRequiredmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.consentPrompt.esstringOptionalmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.components[].nodes[].tokenization.fieldsarray of objectRequiredmaxItems: 7.
plan.flow.components[].nodes[].tokenization.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].tokenization.fields[].parameterstringRequiredmaxLength: 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[].minDigitsintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].tokenization.fields[].maxDigitsintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].tokenization.fields[].encoding"string" · "integer"Required—
plan.flow.components[].nodes[].tokenization.fields[].minimumintegerOptionalAt least 0. At most 999999999.
plan.flow.components[].nodes[].tokenization.fields[].maximumintegerOptionalAt least 0. At most 999999999.
plan.flow.components[].nodes[].tokenization.fields[].promptobjectRequired—
plan.flow.components[].nodes[].tokenization.fields[].prompt.enstringRequiredmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.fields[].prompt.esstringOptionalmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.components[].nodes[].tokenization.arguments[].parameterstringRequiredmaxLength: 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[].sourceobjectRequired—
plan.flow.components[].nodes[].tokenization.arguments[].source · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.kind"variable"Required—
plan.flow.components[].nodes[].tokenization.arguments[].source.namestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.arguments[].source · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.kind"constant"Required—
plan.flow.components[].nodes[].tokenization.arguments[].source.valuestring or number or boolean or nullRequired—
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 1string—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 2number—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 3boolean—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.tokenIdPathstringRequiredmaxLength: 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.tokenVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.last4VariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.last4FieldstringRequiredmaxLength: 64.
plan.flow.components[].nodes[].componentIdstringOptionalminLength: 1.
plan.flow.components[].toolsarray of objectRequired—
plan.flow.components[].tools[].idstringRequiredminLength: 1.
plan.flow.components[].tools[].type"custom"Required—
plan.flow.components[].tools[].namestringRequiredminLength: 1.
plan.flow.components[].tools[].descriptionstringRequired—
plan.flow.components[].tools[].urlstringRequired—
plan.flow.components[].tools[].method"GET" · "POST" · "PUT" · "PATCH" · "DELETE"Required—
plan.flow.components[].tools[].headersobjectRequired—
plan.flow.components[].tools[].headers.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].queryParamsobjectRequired—
plan.flow.components[].tools[].queryParams.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].credentialobjectOptional—
plan.flow.components[].tools[].credential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.components[].tools[].parametersobjectRequired—
plan.flow.components[].tools[].parameters.*any JSON valueOptionalAdditional keys are allowed.
plan.flow.components[].tools[].responseVariablesobjectRequired—
plan.flow.components[].tools[].responseVariables.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].timeoutMsintegerRequiredAt least -9007199254740991. At most 9007199254740991.
plan.flow.components[].tools[].responseVariablePolicy"required" · "replace_available"Optional—
plan.flow.components[].tools[].argsAtRootbooleanRequired—
plan.flow.components[].tools[].parameterType"json"Required—
plan.flow.components[].tools[].speakAfterExecutionbooleanOptional—
plan.flow.components[].flexModebooleanOptional—
plan.flow.toolsarray of objectRequired—
plan.flow.tools[].idstringRequiredminLength: 1.
plan.flow.tools[].type"custom"Required—
plan.flow.tools[].namestringRequiredminLength: 1.
plan.flow.tools[].descriptionstringRequired—
plan.flow.tools[].urlstringRequired—
plan.flow.tools[].method"GET" · "POST" · "PUT" · "PATCH" · "DELETE"Required—
plan.flow.tools[].headersobjectRequired—
plan.flow.tools[].headers.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].queryParamsobjectRequired—
plan.flow.tools[].queryParams.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].credentialobjectOptional—
plan.flow.tools[].credential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.tools[].parametersobjectRequired—
plan.flow.tools[].parameters.*any JSON valueOptionalAdditional keys are allowed.
plan.flow.tools[].responseVariablesobjectRequired—
plan.flow.tools[].responseVariables.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].timeoutMsintegerRequiredAt least -9007199254740991. At most 9007199254740991.
plan.flow.tools[].responseVariablePolicy"required" · "replace_available"Optional—
plan.flow.tools[].argsAtRootbooleanRequired—
plan.flow.tools[].parameterType"json"Required—
plan.flow.tools[].speakAfterExecutionbooleanOptional—
plan.flow.defaultDynamicVariablesobjectRequired—
plan.flow.defaultDynamicVariables.*stringOptionalAdditional keys are allowed.
plan.flow.callContextVariablesarray of stringOptional—
plan.flow.modelChoiceobjectOptional—
plan.flow.modelChoice.modelobjectRequired—
plan.flow.modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.modelChoice.credentialobjectOptional—
plan.flow.modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.type"cascading"Required—
plan.flow.modelChoice.highPrioritybooleanRequired—
plan.flow.modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.toolCallStrictModebooleanRequired—
plan.actionsarray of objectRequired—
plan.actions[].binding_idstringRequiredminLength: 1. maxLength: 128.
plan.actions[].actionobjectRequired—
plan.actions[].action.idstringRequired—
plan.actions[].action.versionintegerRequiredGreater than 0. At most 9007199254740991.
plan.actions[].configobjectRequired—
plan.actions[].config.*any JSON valueOptionalAdditional keys are allowed.
plan.actions[].secret_refsarray of objectRequired—
plan.actions[].secret_refs[].idstringRequiredminLength: 1. maxLength: 128.
plan.actions[].secret_refs[].versionstringRequiredminLength: 1. maxLength: 128.
plan.actions[].node_idsarray of stringRequired—
plan.notificationsarray of objectRequired—
plan.notifications[].idstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].urlstring (uri)Required—
plan.notifications[].secret_refobjectRequired—
plan.notifications[].secret_ref.idstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].secret_ref.versionstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].format"semantic.v1"Required—
plan.notifications[].eventsarray of "run.admitted" · "run.ended" · "recording.updated" · "analysis.updated"RequiredminItems: 1.
plan.knowledgearray of objectRequired—
plan.knowledge[].pin_idstring (uuid)Requiredpattern: ^([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_idstring (uuid)Requiredpattern: ^([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_identityobjectRequired—
plan.knowledge[].model_identity.model_idstringRequiredminLength: 1. pattern: \S.
plan.knowledge[].model_identity.providerstringRequiredminLength: 1. pattern: \S.
plan.knowledge[].model_identity.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.knowledge[].dimensionintegerRequiredGreater than 0. At most 9007199254740991.
plan.knowledge[].document_idsarray of string (uuid)RequiredminItems: 1.
plan.knowledge[].documents_sha256stringRequiredpattern: ^[a-f0-9]{64}$.
plan.triggersarray of objectRequired—
plan.triggers[] · variant 1object—Fields for this schema branch.
plan.triggers[].kind"schedule"Required—
plan.triggers[].idstringRequiredminLength: 1. maxLength: 128.
plan.triggers[].cronstringRequiredpattern: ^(\S+\s+){4}\S+$.
plan.triggers[].timezonestringRequiredminLength: 1. maxLength: 64.
plan.triggers[].inputobjectRequired—
plan.triggers[].input.*any JSON valueOptionalAdditional keys are allowed.
plan.triggers[] · variant 2object—Fields for this schema branch.
plan.triggers[].kind"event"Required—
plan.triggers[].idstringRequiredminLength: 1. maxLength: 128.
plan.triggers[].event_type"run.ended" · "analysis.updated"Required—
plan.triggers[].sourceobjectRequired—
plan.triggers[].source.agent_idstringOptionalAgent 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.dispositionsarray of stringOptionalmaxItems: 32.
plan.triggers[].input_mappingobjectRequired—
plan.triggers[].input_mapping.*stringOptionalAdditional keys are allowed.
plan.providersobjectRequired—
plan.providers.llmobjectRequired—
plan.providers.llm.modelobjectRequired—
plan.providers.llm.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.providers.llm.model.providerstringRequiredminLength: 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.credentialobject or nullRequired—
plan.providers.llm.credential.idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.llm.credential.versionstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.llm.credential.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysisobject or nullRequired—
plan.providers.analysis.modelobjectRequired in a non-null parent—
plan.providers.analysis.model.model_idstringRequired in a non-null parentminLength: 1. pattern: \S.
plan.providers.analysis.model.providerstringRequired in a non-null parentminLength: 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.credentialobject or nullRequired in a non-null parent—
plan.providers.analysis.credential.idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysis.credential.versionstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysis.credential.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.sttobject or nullRequired—
plan.providers.stt.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.stt.modelstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.stt.route"platform" · "fleet" · "simulated"Required in a non-null parent—
plan.providers.stt.languagesarray of "en" · "es"Required in a non-null parentminItems: 1.
plan.providers.ttsobject or nullRequired—
plan.providers.tts.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.modelstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.voice_idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.route"platform" · "simulated"Required in a non-null parent—
plan.providers.tts.languagesarray of "en" · "es"Required in a non-null parentminItems: 1.
plan.analysisarray of objectRequired—
plan.analysis[].*any JSON valueOptionalAdditional keys are allowed.
plan.policyobjectRequired—
plan.policy.policy_versionstringRequiredpattern: ^[a-f0-9]{12}$.
layoutobjectRequired—
layout.flowobjectRequired—
layout.flow.nodesobjectRequired—
layout.flow.nodes.*objectOptionalAdditional keys are allowed.
layout.flow.startobjectOptional—
layout.flow.start.xnumberRequiredAt least -10000000. At most 10000000.
layout.flow.start.ynumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewportobjectOptional—
layout.flow.viewport.xnumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewport.ynumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewport.zoomnumberRequiredAt least 0.01. At most 100.
layout.componentsobjectRequired—
layout.components.*objectOptionalAdditional keys are allowed.

HTTP 201

Publish the draft as the next immutable version; moves head unless live is false (201; replay 200)

application/json

FieldType or valuesRequiredDescription and limits
refobjectRequired—
ref.agent_idstringRequiredAgent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$.
ref.versionintegerRequiredAt least 0. At most 2147483647.
ref.digeststringRequiredpattern: ^sha256:[a-f0-9]{64}$.
published_atstring (date-time)Requiredpattern: ^(?:(?:\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_byobject or nullRequired—
published_by · combined section 1object—Fields for this schema branch.
published_by · variant 1object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"user"Required in a non-null parent—
published_by.idstring (uuid)Required in a non-null parentpattern: ^([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 2object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"api_key"Required in a non-null parent—
published_by.idstring (uuid)Required in a non-null parentpattern: ^([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 3object—Fields for this schema branch.
published_by.owner_idstringRequired in a non-null parentminLength: 1.
published_by.environmentstringRequired in a non-null parentminLength: 1.
published_by.kind"system"Required in a non-null parent—
published_by.idstringRequired in a non-null parentminLength: 1. maxLength: 256.
is_headbooleanRequired—
testbooleanRequired—
planobjectRequired—
plan.plan_schema_version2Required—
plan.compilerobjectRequired—
plan.compiler.name"talos-compiler"Required—
plan.compiler.versionstringRequiredminLength: 1.
plan.agentobjectRequired—
plan.agent.agent_idstringRequiredAgent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$.
plan.agent.versionintegerRequiredAt least 0. At most 2147483647.
plan.agent.namestringRequiredminLength: 1. maxLength: 256.
plan.sourceobjectRequired—
plan.source.kind"studio" · "retell_import" · "api"Required—
plan.source.sha256stringRequiredpattern: ^[a-f0-9]{64}$.
plan.channelsobjectRequired—
plan.channels.cloudobject or nullRequired—
plan.channels.cloud.modesarray of "task" · "chat" · "background"Required in a non-null parentminItems: 1.
plan.channels.cloud.input_schemaobjectRequired in a non-null parent—
plan.channels.cloud.input_schema.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.cloud.output_schemaobjectRequired in a non-null parent—
plan.channels.cloud.output_schema.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.cloud.max_turnsintegerRequired in a non-null parentAt least 1. At most 200.
plan.channels.cloud.idle_timeout_msintegerRequired in a non-null parentAt least 10000. At most 86400000.
plan.channels.cloud.deadline_msintegerRequired in a non-null parentAt least 1000. At most 3600000.
plan.channels.phoneobject or nullRequired—
plan.channels.phone.telephonyobject or nullRequired in a non-null parent—
plan.channels.phone.telephony.trunk_idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.channels.phone.telephony.fromstring or nullRequired in a non-null parentpattern: ^+[1-9][0-9]{6,14}$.
plan.channels.phone.inbound_contextobjectOptional—
plan.channels.phone.inbound_context.action_idstringRequired in a non-null parentpattern: ^[a-z][a-z0-9_]{0,62}$.
plan.channels.phone.inbound_context.variablesarray of stringRequired in a non-null parentminItems: 1. maxItems: 256.
plan.channels.phone.settingsobjectRequired in a non-null parent—
plan.channels.phone.settings.*any JSON valueOptionalAdditional keys are allowed.
plan.channels.phone.recordingobjectRequired in a non-null parent—
plan.channels.phone.recording.requiredbooleanRequired in a non-null parent—
plan.channels.phone.recording.channels"dual"Required in a non-null parent—
plan.languagesarray of "en" · "es"RequiredminItems: 1.
plan.flowobjectRequired—
plan.flow.schemaVersion2Required—
plan.flow.compilerVersionstringRequiredminLength: 1.
plan.flow.sourceHashstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.idstringRequiredminLength: 1.
plan.flow.versionintegerRequiredAt least 0. At most 9007199254740991.
plan.flow.startNodeIdstringRequiredminLength: 1.
plan.flow.startSpeaker"agent" · "user"Required—
plan.flow.globalPromptstringRequired—
plan.flow.nodesarray of objectRequired—
plan.flow.nodes[].idstringRequiredminLength: 1.
plan.flow.nodes[].kind"conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component"Required—
plan.flow.nodes[].namestringOptional—
plan.flow.nodes[].instructionobjectOptional—
plan.flow.nodes[].instruction.type"prompt" · "static_text"Required—
plan.flow.nodes[].instruction.textstringRequired—
plan.flow.nodes[].edgesarray of objectRequired—
plan.flow.nodes[].edges[].idstringOptionalminLength: 1.
plan.flow.nodes[].edges[].destinationNodeIdstringOptionalminLength: 1.
plan.flow.nodes[].edges[].slot"edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge"Required—
plan.flow.nodes[].edges[].conditionobjectRequired—
plan.flow.nodes[].edges[].condition · variant 1object—Fields for this schema branch.
plan.flow.nodes[].edges[].condition.type"always"Required—
plan.flow.nodes[].edges[].condition · variant 2object—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 3object—Fields for this schema branch.
plan.flow.nodes[].edges[].condition.type"prompt"Required—
plan.flow.nodes[].edges[].condition.promptstringRequired—
plan.flow.nodes[].edges[].condition · variant 4object—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.equationsarray of objectRequiredminItems: 1.
plan.flow.nodes[].edges[].condition.equations[].leftstringRequired—
plan.flow.nodes[].edges[].condition.equations[].operator"==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set"Required—
plan.flow.nodes[].edges[].condition.equations[].rightstringRequired—
plan.flow.nodes[].edges[].labelstringOptional—
plan.flow.nodes[].edges[].complianceobjectOptional—
plan.flow.nodes[].edges[].compliance.setsarray of "rpc_confirmed"RequiredminItems: 1.
plan.flow.nodes[].startSpeaker"agent" · "user"Optional—
plan.flow.nodes[].interruptionSensitivitynumberOptional—
plan.flow.nodes[].voiceSpeednumberOptional—
plan.flow.nodes[].languageLockedbooleanOptional—
plan.flow.nodes[].globalNodeSettingobjectOptional—
plan.flow.nodes[].globalNodeSetting.conditionstringRequired—
plan.flow.nodes[].globalNodeSetting.coolDownnumberOptional—
plan.flow.nodes[].speakDuringExecutionbooleanOptional—
plan.flow.nodes[].executionMessageobjectOptional—
plan.flow.nodes[].executionMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].executionMessage.textstringRequired—
plan.flow.nodes[].toolIdstringOptionalminLength: 1.
plan.flow.nodes[].waitForResultbooleanOptional—
plan.flow.nodes[].transferobjectOptional—
plan.flow.nodes[].transfer.destinationobjectRequired—
plan.flow.nodes[].transfer.destination · variant 1object—Fields for this schema branch.
plan.flow.nodes[].transfer.destination.type"predefined"Required—
plan.flow.nodes[].transfer.destination.numberstringRequired—
plan.flow.nodes[].transfer.destination · variant 2object—Fields for this schema branch.
plan.flow.nodes[].transfer.destination.type"inferred"Required—
plan.flow.nodes[].transfer.destination.promptstringRequired—
plan.flow.nodes[].transfer.optionobjectRequired—
plan.flow.nodes[].transfer.option.type"cold_transfer" · "warm_transfer"Required—
plan.flow.nodes[].transfer.option.showTransfereeAsCallerbooleanOptional—
plan.flow.nodes[].transfer.option.optOutHumanDetectionbooleanOptional—
plan.flow.nodes[].transfer.option.enableBridgeAudioCuebooleanOptional—
plan.flow.nodes[].transfer.option.onHoldMusicstringOptional—
plan.flow.nodes[].transfer.option.agentDetectionTimeoutMsintegerOptionalAt least -9007199254740991. At most 9007199254740991.
plan.flow.nodes[].transfer.option.agentDetectionPromptstringOptional—
plan.flow.nodes[].transfer.option.transferMessageobjectOptional—
plan.flow.nodes[].transfer.option.transferMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].transfer.option.transferMessage.textstringRequired—
plan.flow.nodes[].transfer.option.privateHandoffMessageobjectOptional—
plan.flow.nodes[].transfer.option.privateHandoffMessage.type"prompt" · "static_text"Required—
plan.flow.nodes[].transfer.option.privateHandoffMessage.textstringRequired—
plan.flow.nodes[].transfer.option.coldTransferModestringOptional—
plan.flow.nodes[].transfer.customSipHeadersobjectRequired—
plan.flow.nodes[].transfer.customSipHeaders.*stringOptionalAdditional keys are allowed.
plan.flow.nodes[].transfer.headerCredentialobjectOptional—
plan.flow.nodes[].transfer.headerCredential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.nodes[].transfer.ignoreE164ValidationbooleanRequired—
plan.flow.nodes[].variablesarray of objectOptional—
plan.flow.nodes[].variables[].namestringRequiredminLength: 1.
plan.flow.nodes[].variables[].type"string" · "number" · "boolean" · "enum"Required—
plan.flow.nodes[].variables[].descriptionstringRequired—
plan.flow.nodes[].variables[].choicesarray of stringOptional—
plan.flow.nodes[].modelChoiceobjectOptional—
plan.flow.nodes[].modelChoice.modelobjectRequired—
plan.flow.nodes[].modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.nodes[].modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.nodes[].modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.nodes[].modelChoice.credentialobjectOptional—
plan.flow.nodes[].modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.nodes[].modelChoice.type"cascading"Required—
plan.flow.nodes[].modelChoice.highPrioritybooleanRequired—
plan.flow.nodes[].modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.nodes[].verificationobjectOptional—
plan.flow.nodes[].verification.subjectVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fieldsarray of objectRequiredmaxItems: 8.
plan.flow.nodes[].verification.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].verification.fields[].expectedVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fields[].privateAliasesarray of stringOptionalmaxItems: 16.
plan.flow.nodes[].verification.fields[].enabledVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.fields[].formatobjectRequired—
plan.flow.nodes[].verification.fields[].format · variant 1object—Fields for this schema branch.
plan.flow.nodes[].verification.fields[].format.kind"digits"Required—
plan.flow.nodes[].verification.fields[].format.lengthintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].verification.fields[].format · variant 2object—Fields for this schema branch.
plan.flow.nodes[].verification.fields[].format.kind"date_yyyymmdd"Required—
plan.flow.nodes[].verification.fields[].promptobjectRequired—
plan.flow.nodes[].verification.fields[].prompt.enstringRequired—
plan.flow.nodes[].verification.fields[].prompt.esstringOptional—
plan.flow.nodes[].verification.requiredobjectRequired—
plan.flow.nodes[].verification.required · variant 1object—Fields for this schema branch.
plan.flow.nodes[].verification.required.kind"fixed"Required—
plan.flow.nodes[].verification.required.countintegerRequiredAt least 1. At most 8.
plan.flow.nodes[].verification.required · variant 2object—Fields for this schema branch.
plan.flow.nodes[].verification.required.kind"variable"Required—
plan.flow.nodes[].verification.required.namestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.nodes[].verification.lookupobjectOptional—
plan.flow.nodes[].verification.lookup.toolIdstringRequiredminLength: 1.
plan.flow.nodes[].verification.lookup.fieldIdstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].verification.lookup.parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.lookup.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.nodes[].verification.lookup.arguments[].parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].verification.lookup.arguments[].variablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenizationobjectOptional—
plan.flow.nodes[].tokenization.toolIdstringRequiredmaxLength: 256.
plan.flow.nodes[].tokenization.subjectVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.consentPromptobjectRequired—
plan.flow.nodes[].tokenization.consentPrompt.enstringRequiredmaxLength: 4096.
plan.flow.nodes[].tokenization.consentPrompt.esstringOptionalmaxLength: 4096.
plan.flow.nodes[].tokenization.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.nodes[].tokenization.fieldsarray of objectRequiredmaxItems: 7.
plan.flow.nodes[].tokenization.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.nodes[].tokenization.fields[].parameterstringRequiredmaxLength: 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[].minDigitsintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].tokenization.fields[].maxDigitsintegerRequiredAt least 1. At most 32.
plan.flow.nodes[].tokenization.fields[].encoding"string" · "integer"Required—
plan.flow.nodes[].tokenization.fields[].minimumintegerOptionalAt least 0. At most 999999999.
plan.flow.nodes[].tokenization.fields[].maximumintegerOptionalAt least 0. At most 999999999.
plan.flow.nodes[].tokenization.fields[].promptobjectRequired—
plan.flow.nodes[].tokenization.fields[].prompt.enstringRequiredmaxLength: 4096.
plan.flow.nodes[].tokenization.fields[].prompt.esstringOptionalmaxLength: 4096.
plan.flow.nodes[].tokenization.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.nodes[].tokenization.arguments[].parameterstringRequiredmaxLength: 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[].sourceobjectRequired—
plan.flow.nodes[].tokenization.arguments[].source · variant 1object—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.kind"variable"Required—
plan.flow.nodes[].tokenization.arguments[].source.namestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.arguments[].source · variant 2object—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.kind"constant"Required—
plan.flow.nodes[].tokenization.arguments[].source.valuestring or number or boolean or nullRequired—
plan.flow.nodes[].tokenization.arguments[].source.value · variant 1string—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.value · variant 2number—Fields for this schema branch.
plan.flow.nodes[].tokenization.arguments[].source.value · variant 3boolean—Fields for this schema branch.
plan.flow.nodes[].tokenization.tokenIdPathstringRequiredmaxLength: 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.tokenVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.last4VariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.nodes[].tokenization.last4FieldstringRequiredmaxLength: 64.
plan.flow.nodes[].componentIdstringOptionalminLength: 1.
plan.flow.componentsarray of objectRequired—
plan.flow.components[].idstringRequiredminLength: 1.
plan.flow.components[].startNodeIdstringRequiredminLength: 1.
plan.flow.components[].nodesarray of objectRequired—
plan.flow.components[].nodes[].idstringRequiredminLength: 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[].namestringOptional—
plan.flow.components[].nodes[].instructionobjectOptional—
plan.flow.components[].nodes[].instruction.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].instruction.textstringRequired—
plan.flow.components[].nodes[].edgesarray of objectRequired—
plan.flow.components[].nodes[].edges[].idstringOptionalminLength: 1.
plan.flow.components[].nodes[].edges[].destinationNodeIdstringOptionalminLength: 1.
plan.flow.components[].nodes[].edges[].slot"edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge"Required—
plan.flow.components[].nodes[].edges[].conditionobjectRequired—
plan.flow.components[].nodes[].edges[].condition · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].edges[].condition.type"always"Required—
plan.flow.components[].nodes[].edges[].condition · variant 2object—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 3object—Fields for this schema branch.
plan.flow.components[].nodes[].edges[].condition.type"prompt"Required—
plan.flow.components[].nodes[].edges[].condition.promptstringRequired—
plan.flow.components[].nodes[].edges[].condition · variant 4object—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.equationsarray of objectRequiredminItems: 1.
plan.flow.components[].nodes[].edges[].condition.equations[].leftstringRequired—
plan.flow.components[].nodes[].edges[].condition.equations[].operator"==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set"Required—
plan.flow.components[].nodes[].edges[].condition.equations[].rightstringRequired—
plan.flow.components[].nodes[].edges[].labelstringOptional—
plan.flow.components[].nodes[].edges[].complianceobjectOptional—
plan.flow.components[].nodes[].edges[].compliance.setsarray of "rpc_confirmed"RequiredminItems: 1.
plan.flow.components[].nodes[].startSpeaker"agent" · "user"Optional—
plan.flow.components[].nodes[].interruptionSensitivitynumberOptional—
plan.flow.components[].nodes[].voiceSpeednumberOptional—
plan.flow.components[].nodes[].languageLockedbooleanOptional—
plan.flow.components[].nodes[].globalNodeSettingobjectOptional—
plan.flow.components[].nodes[].globalNodeSetting.conditionstringRequired—
plan.flow.components[].nodes[].globalNodeSetting.coolDownnumberOptional—
plan.flow.components[].nodes[].speakDuringExecutionbooleanOptional—
plan.flow.components[].nodes[].executionMessageobjectOptional—
plan.flow.components[].nodes[].executionMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].executionMessage.textstringRequired—
plan.flow.components[].nodes[].toolIdstringOptionalminLength: 1.
plan.flow.components[].nodes[].waitForResultbooleanOptional—
plan.flow.components[].nodes[].transferobjectOptional—
plan.flow.components[].nodes[].transfer.destinationobjectRequired—
plan.flow.components[].nodes[].transfer.destination · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].transfer.destination.type"predefined"Required—
plan.flow.components[].nodes[].transfer.destination.numberstringRequired—
plan.flow.components[].nodes[].transfer.destination · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].transfer.destination.type"inferred"Required—
plan.flow.components[].nodes[].transfer.destination.promptstringRequired—
plan.flow.components[].nodes[].transfer.optionobjectRequired—
plan.flow.components[].nodes[].transfer.option.type"cold_transfer" · "warm_transfer"Required—
plan.flow.components[].nodes[].transfer.option.showTransfereeAsCallerbooleanOptional—
plan.flow.components[].nodes[].transfer.option.optOutHumanDetectionbooleanOptional—
plan.flow.components[].nodes[].transfer.option.enableBridgeAudioCuebooleanOptional—
plan.flow.components[].nodes[].transfer.option.onHoldMusicstringOptional—
plan.flow.components[].nodes[].transfer.option.agentDetectionTimeoutMsintegerOptionalAt least -9007199254740991. At most 9007199254740991.
plan.flow.components[].nodes[].transfer.option.agentDetectionPromptstringOptional—
plan.flow.components[].nodes[].transfer.option.transferMessageobjectOptional—
plan.flow.components[].nodes[].transfer.option.transferMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].transfer.option.transferMessage.textstringRequired—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessageobjectOptional—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.type"prompt" · "static_text"Required—
plan.flow.components[].nodes[].transfer.option.privateHandoffMessage.textstringRequired—
plan.flow.components[].nodes[].transfer.option.coldTransferModestringOptional—
plan.flow.components[].nodes[].transfer.customSipHeadersobjectRequired—
plan.flow.components[].nodes[].transfer.customSipHeaders.*stringOptionalAdditional keys are allowed.
plan.flow.components[].nodes[].transfer.headerCredentialobjectOptional—
plan.flow.components[].nodes[].transfer.headerCredential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.components[].nodes[].transfer.ignoreE164ValidationbooleanRequired—
plan.flow.components[].nodes[].variablesarray of objectOptional—
plan.flow.components[].nodes[].variables[].namestringRequiredminLength: 1.
plan.flow.components[].nodes[].variables[].type"string" · "number" · "boolean" · "enum"Required—
plan.flow.components[].nodes[].variables[].descriptionstringRequired—
plan.flow.components[].nodes[].variables[].choicesarray of stringOptional—
plan.flow.components[].nodes[].modelChoiceobjectOptional—
plan.flow.components[].nodes[].modelChoice.modelobjectRequired—
plan.flow.components[].nodes[].modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.components[].nodes[].modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.components[].nodes[].modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.components[].nodes[].modelChoice.credentialobjectOptional—
plan.flow.components[].nodes[].modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.components[].nodes[].modelChoice.type"cascading"Required—
plan.flow.components[].nodes[].modelChoice.highPrioritybooleanRequired—
plan.flow.components[].nodes[].modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.components[].nodes[].verificationobjectOptional—
plan.flow.components[].nodes[].verification.subjectVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fieldsarray of objectRequiredmaxItems: 8.
plan.flow.components[].nodes[].verification.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].verification.fields[].expectedVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fields[].privateAliasesarray of stringOptionalmaxItems: 16.
plan.flow.components[].nodes[].verification.fields[].enabledVariablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.fields[].formatobjectRequired—
plan.flow.components[].nodes[].verification.fields[].format · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.fields[].format.kind"digits"Required—
plan.flow.components[].nodes[].verification.fields[].format.lengthintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].verification.fields[].format · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.fields[].format.kind"date_yyyymmdd"Required—
plan.flow.components[].nodes[].verification.fields[].promptobjectRequired—
plan.flow.components[].nodes[].verification.fields[].prompt.enstringRequired—
plan.flow.components[].nodes[].verification.fields[].prompt.esstringOptional—
plan.flow.components[].nodes[].verification.requiredobjectRequired—
plan.flow.components[].nodes[].verification.required · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.required.kind"fixed"Required—
plan.flow.components[].nodes[].verification.required.countintegerRequiredAt least 1. At most 8.
plan.flow.components[].nodes[].verification.required · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].verification.required.kind"variable"Required—
plan.flow.components[].nodes[].verification.required.namestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.components[].nodes[].verification.lookupobjectOptional—
plan.flow.components[].nodes[].verification.lookup.toolIdstringRequiredminLength: 1.
plan.flow.components[].nodes[].verification.lookup.fieldIdstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].verification.lookup.parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.lookup.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.components[].nodes[].verification.lookup.arguments[].parameterstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].verification.lookup.arguments[].variablestringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenizationobjectOptional—
plan.flow.components[].nodes[].tokenization.toolIdstringRequiredmaxLength: 256.
plan.flow.components[].nodes[].tokenization.subjectVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.consentPromptobjectRequired—
plan.flow.components[].nodes[].tokenization.consentPrompt.enstringRequiredmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.consentPrompt.esstringOptionalmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.timeoutMsintegerRequiredAt least 1000. At most 180000.
plan.flow.components[].nodes[].tokenization.fieldsarray of objectRequiredmaxItems: 7.
plan.flow.components[].nodes[].tokenization.fields[].idstringRequiredpattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$.
plan.flow.components[].nodes[].tokenization.fields[].parameterstringRequiredmaxLength: 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[].minDigitsintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].tokenization.fields[].maxDigitsintegerRequiredAt least 1. At most 32.
plan.flow.components[].nodes[].tokenization.fields[].encoding"string" · "integer"Required—
plan.flow.components[].nodes[].tokenization.fields[].minimumintegerOptionalAt least 0. At most 999999999.
plan.flow.components[].nodes[].tokenization.fields[].maximumintegerOptionalAt least 0. At most 999999999.
plan.flow.components[].nodes[].tokenization.fields[].promptobjectRequired—
plan.flow.components[].nodes[].tokenization.fields[].prompt.enstringRequiredmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.fields[].prompt.esstringOptionalmaxLength: 4096.
plan.flow.components[].nodes[].tokenization.argumentsarray of objectRequiredmaxItems: 64.
plan.flow.components[].nodes[].tokenization.arguments[].parameterstringRequiredmaxLength: 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[].sourceobjectRequired—
plan.flow.components[].nodes[].tokenization.arguments[].source · variant 1object—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.kind"variable"Required—
plan.flow.components[].nodes[].tokenization.arguments[].source.namestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.arguments[].source · variant 2object—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.kind"constant"Required—
plan.flow.components[].nodes[].tokenization.arguments[].source.valuestring or number or boolean or nullRequired—
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 1string—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 2number—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.arguments[].source.value · variant 3boolean—Fields for this schema branch.
plan.flow.components[].nodes[].tokenization.tokenIdPathstringRequiredmaxLength: 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.tokenVariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.last4VariablestringRequiredpattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$.
plan.flow.components[].nodes[].tokenization.last4FieldstringRequiredmaxLength: 64.
plan.flow.components[].nodes[].componentIdstringOptionalminLength: 1.
plan.flow.components[].toolsarray of objectRequired—
plan.flow.components[].tools[].idstringRequiredminLength: 1.
plan.flow.components[].tools[].type"custom"Required—
plan.flow.components[].tools[].namestringRequiredminLength: 1.
plan.flow.components[].tools[].descriptionstringRequired—
plan.flow.components[].tools[].urlstringRequired—
plan.flow.components[].tools[].method"GET" · "POST" · "PUT" · "PATCH" · "DELETE"Required—
plan.flow.components[].tools[].headersobjectRequired—
plan.flow.components[].tools[].headers.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].queryParamsobjectRequired—
plan.flow.components[].tools[].queryParams.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].credentialobjectOptional—
plan.flow.components[].tools[].credential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.components[].tools[].parametersobjectRequired—
plan.flow.components[].tools[].parameters.*any JSON valueOptionalAdditional keys are allowed.
plan.flow.components[].tools[].responseVariablesobjectRequired—
plan.flow.components[].tools[].responseVariables.*stringOptionalAdditional keys are allowed.
plan.flow.components[].tools[].timeoutMsintegerRequiredAt least -9007199254740991. At most 9007199254740991.
plan.flow.components[].tools[].responseVariablePolicy"required" · "replace_available"Optional—
plan.flow.components[].tools[].argsAtRootbooleanRequired—
plan.flow.components[].tools[].parameterType"json"Required—
plan.flow.components[].tools[].speakAfterExecutionbooleanOptional—
plan.flow.components[].flexModebooleanOptional—
plan.flow.toolsarray of objectRequired—
plan.flow.tools[].idstringRequiredminLength: 1.
plan.flow.tools[].type"custom"Required—
plan.flow.tools[].namestringRequiredminLength: 1.
plan.flow.tools[].descriptionstringRequired—
plan.flow.tools[].urlstringRequired—
plan.flow.tools[].method"GET" · "POST" · "PUT" · "PATCH" · "DELETE"Required—
plan.flow.tools[].headersobjectRequired—
plan.flow.tools[].headers.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].queryParamsobjectRequired—
plan.flow.tools[].queryParams.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].credentialobjectOptional—
plan.flow.tools[].credential.idstring (uuid)Requiredpattern: ^([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.versionstringRequiredpattern: ^[a-f0-9]{64}$.
plan.flow.tools[].parametersobjectRequired—
plan.flow.tools[].parameters.*any JSON valueOptionalAdditional keys are allowed.
plan.flow.tools[].responseVariablesobjectRequired—
plan.flow.tools[].responseVariables.*stringOptionalAdditional keys are allowed.
plan.flow.tools[].timeoutMsintegerRequiredAt least -9007199254740991. At most 9007199254740991.
plan.flow.tools[].responseVariablePolicy"required" · "replace_available"Optional—
plan.flow.tools[].argsAtRootbooleanRequired—
plan.flow.tools[].parameterType"json"Required—
plan.flow.tools[].speakAfterExecutionbooleanOptional—
plan.flow.defaultDynamicVariablesobjectRequired—
plan.flow.defaultDynamicVariables.*stringOptionalAdditional keys are allowed.
plan.flow.callContextVariablesarray of stringOptional—
plan.flow.modelChoiceobjectOptional—
plan.flow.modelChoice.modelobjectRequired—
plan.flow.modelChoice.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.flow.modelChoice.model.providerstringRequiredminLength: 1. pattern: \S.
plan.flow.modelChoice.model.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.flow.modelChoice.credentialobjectOptional—
plan.flow.modelChoice.credential.idstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.credential.versionstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.credential.providerstringRequiredminLength: 1. maxLength: 256.
plan.flow.modelChoice.type"cascading"Required—
plan.flow.modelChoice.highPrioritybooleanRequired—
plan.flow.modelChoice.reasoningEffort"low" · "medium" · "high"Optional—
plan.flow.toolCallStrictModebooleanRequired—
plan.actionsarray of objectRequired—
plan.actions[].binding_idstringRequiredminLength: 1. maxLength: 128.
plan.actions[].actionobjectRequired—
plan.actions[].action.idstringRequired—
plan.actions[].action.versionintegerRequiredGreater than 0. At most 9007199254740991.
plan.actions[].configobjectRequired—
plan.actions[].config.*any JSON valueOptionalAdditional keys are allowed.
plan.actions[].secret_refsarray of objectRequired—
plan.actions[].secret_refs[].idstringRequiredminLength: 1. maxLength: 128.
plan.actions[].secret_refs[].versionstringRequiredminLength: 1. maxLength: 128.
plan.actions[].node_idsarray of stringRequired—
plan.notificationsarray of objectRequired—
plan.notifications[].idstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].urlstring (uri)Required—
plan.notifications[].secret_refobjectRequired—
plan.notifications[].secret_ref.idstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].secret_ref.versionstringRequiredminLength: 1. maxLength: 128.
plan.notifications[].format"semantic.v1"Required—
plan.notifications[].eventsarray of "run.admitted" · "run.ended" · "recording.updated" · "analysis.updated"RequiredminItems: 1.
plan.knowledgearray of objectRequired—
plan.knowledge[].pin_idstring (uuid)Requiredpattern: ^([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_idstring (uuid)Requiredpattern: ^([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_identityobjectRequired—
plan.knowledge[].model_identity.model_idstringRequiredminLength: 1. pattern: \S.
plan.knowledge[].model_identity.providerstringRequiredminLength: 1. pattern: \S.
plan.knowledge[].model_identity.tier"frontier" · "cumulus-served" · "customer-gpu"Required—
plan.knowledge[].dimensionintegerRequiredGreater than 0. At most 9007199254740991.
plan.knowledge[].document_idsarray of string (uuid)RequiredminItems: 1.
plan.knowledge[].documents_sha256stringRequiredpattern: ^[a-f0-9]{64}$.
plan.triggersarray of objectRequired—
plan.triggers[] · variant 1object—Fields for this schema branch.
plan.triggers[].kind"schedule"Required—
plan.triggers[].idstringRequiredminLength: 1. maxLength: 128.
plan.triggers[].cronstringRequiredpattern: ^(\S+\s+){4}\S+$.
plan.triggers[].timezonestringRequiredminLength: 1. maxLength: 64.
plan.triggers[].inputobjectRequired—
plan.triggers[].input.*any JSON valueOptionalAdditional keys are allowed.
plan.triggers[] · variant 2object—Fields for this schema branch.
plan.triggers[].kind"event"Required—
plan.triggers[].idstringRequiredminLength: 1. maxLength: 128.
plan.triggers[].event_type"run.ended" · "analysis.updated"Required—
plan.triggers[].sourceobjectRequired—
plan.triggers[].source.agent_idstringOptionalAgent 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.dispositionsarray of stringOptionalmaxItems: 32.
plan.triggers[].input_mappingobjectRequired—
plan.triggers[].input_mapping.*stringOptionalAdditional keys are allowed.
plan.providersobjectRequired—
plan.providers.llmobjectRequired—
plan.providers.llm.modelobjectRequired—
plan.providers.llm.model.model_idstringRequiredminLength: 1. pattern: \S.
plan.providers.llm.model.providerstringRequiredminLength: 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.credentialobject or nullRequired—
plan.providers.llm.credential.idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.llm.credential.versionstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.llm.credential.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysisobject or nullRequired—
plan.providers.analysis.modelobjectRequired in a non-null parent—
plan.providers.analysis.model.model_idstringRequired in a non-null parentminLength: 1. pattern: \S.
plan.providers.analysis.model.providerstringRequired in a non-null parentminLength: 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.credentialobject or nullRequired in a non-null parent—
plan.providers.analysis.credential.idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysis.credential.versionstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.analysis.credential.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.sttobject or nullRequired—
plan.providers.stt.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.stt.modelstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.stt.route"platform" · "fleet" · "simulated"Required in a non-null parent—
plan.providers.stt.languagesarray of "en" · "es"Required in a non-null parentminItems: 1.
plan.providers.ttsobject or nullRequired—
plan.providers.tts.providerstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.modelstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.voice_idstringRequired in a non-null parentminLength: 1. maxLength: 128.
plan.providers.tts.route"platform" · "simulated"Required in a non-null parent—
plan.providers.tts.languagesarray of "en" · "es"Required in a non-null parentminItems: 1.
plan.analysisarray of objectRequired—
plan.analysis[].*any JSON valueOptionalAdditional keys are allowed.
plan.policyobjectRequired—
plan.policy.policy_versionstringRequiredpattern: ^[a-f0-9]{12}$.
layoutobjectRequired—
layout.flowobjectRequired—
layout.flow.nodesobjectRequired—
layout.flow.nodes.*objectOptionalAdditional keys are allowed.
layout.flow.startobjectOptional—
layout.flow.start.xnumberRequiredAt least -10000000. At most 10000000.
layout.flow.start.ynumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewportobjectOptional—
layout.flow.viewport.xnumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewport.ynumberRequiredAt least -10000000. At most 10000000.
layout.flow.viewport.zoomnumberRequiredAt least 0.01. At most 100.
layout.componentsobjectRequired—
layout.components.*objectOptionalAdditional keys are allowed.

Error responses

HTTPDescription
4XXTyped error (ApiError)
5XXTyped error (ApiError)

Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.

Complete OpenAPI schema
OpenAPI JSON
{
  "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
OpenAPI JSON
{
  "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.

Content version 4be416caCustomer SDKMarkdown source
Publish a version · Cumulus developer docs