On this page
Get case results
Read case results and each trial’s assertion verdicts.
Operation ID: test_runs.results.
Request
GET /api/v1/test-runs/{test_run_id}/results
- TypeScript SDK:
client.test_runs.results(path arguments usepath). - MCP tool:
sdk_client_callwithoperationId: "test_runs.results"(path arguments useinput.path). Legacy alias:test_runs_results. Connect to your authenticated/mcpendpoint with an API key for the same environment. - Minimum API key role: viewer.
- Idempotency: No idempotency header required.
Read resource IDs from earlier responses and use a key for the same environment.
Request example
Set each path variable to an ID returned by an earlier API request.
Set CUMULUS_BASE_URL to your workspace API URL and CUMULUS_API_KEY to a key for that environment. Example values are synthetic.
cURL
curl --fail-with-body -sS "${CUMULUS_BASE_URL%/}/api/v1/test-runs/${TEST_RUN_ID}/results" \
-H "Authorization: Bearer $CUMULUS_API_KEY"
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.test_runs.results({
"path": {
"test_run_id": "<test_run_id>"
}
});
Input schema
Path, query and header parameters
test_run_id
path parameter · Required.
Type: string (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})$.
status
query parameter · Optional.
Type: "passed" · "flaky_passed" · "failed" · "errored" · "invalid".
suite_id
query parameter · Optional.
Type: string (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})$.
cursor
query parameter · Optional.
Type: string. maxLength: 1024.
limit
query parameter · Optional.
Type: integer. At least 1. At most 200. Default: 50.
JSON request body
This operation has no JSON request body.
Complete OpenAPI schema
{
"parameters": [
{
"name": "test_run_id",
"in": "path",
"required": true,
"schema": {
"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})$"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"passed",
"flaky_passed",
"failed",
"errored",
"invalid"
]
}
},
{
"name": "suite_id",
"in": "query",
"required": false,
"schema": {
"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})$"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 1024
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 200
}
}
],
"requestBody": null
}
Responses
HTTP 200
List a test run's case results with each trial's assertion verdicts
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
items | array of object | Required | — |
items[].suite_id | string (uuid) | Required | Identifier of the test suite. 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})$. |
items[].case_id | string | Required | minLength: 1. maxLength: 64. pattern: ^[a-z0-9][a-z0-9_-]*$. |
items[].name | string | Required | minLength: 1. maxLength: 200. |
items[].verdict | "passed" · "flaky_passed" · "failed" · "errored" · "invalid" or null | Required | — |
items[].change | "fixed" · "regressed" · "unchanged" · "new" · "removed" or null | Required | — |
items[].blocking | boolean | Required | — |
items[].diagnostics | array of object | Required | maxItems: 50. |
items[].diagnostics[].code | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].path | string | Required | maxLength: 1024. |
items[].diagnostics[].message | string | Required | maxLength: 4096. |
items[].diagnostics[].severity | "warning" · "error" | Required | — |
items[].diagnostics[].fixes | array of object | Optional | maxItems: 8. |
items[].diagnostics[].fixes[].id | string | Required | minLength: 1. maxLength: 64. |
items[].diagnostics[].fixes[].label | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits | array of object | Required | minItems: 1. maxItems: 100. |
| items[].diagnostics[].fixes[].edits[] · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.name" | Required | — |
items[].diagnostics[].fixes[].edits[].name | string | Required | minLength: 1. maxLength: 256. |
| items[].diagnostics[].fixes[].edits[] · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.settings" | Required | — |
items[].diagnostics[].fixes[].edits[].values | object | Required | — |
items[].diagnostics[].fixes[].edits[].values.voiceId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.voiceModel | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.voiceSpeed | number | Optional | At least 0.5. At most 2. |
items[].diagnostics[].fixes[].edits[].values.voiceTemperature | number | Optional | At least 0. At most 2. |
items[].diagnostics[].fixes[].edits[].values.volume | number | Optional | At least 0. At most 2. |
items[].diagnostics[].fixes[].edits[].values.language | string or array of string | Optional | — |
| items[].diagnostics[].fixes[].edits[].values.language · variant 1 | string | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].values.language · variant 2 | array of string | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.responsiveness | number | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].values.interruptionSensitivity | number | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].values.enableBackchannel | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.backchannelFrequency | number | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].values.backchannelWords | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].values.reminderTriggerMs | integer | Optional | At least 0. At most 3600000. |
items[].diagnostics[].fixes[].edits[].values.reminderMaxCount | integer | Optional | At least 0. At most 100. |
items[].diagnostics[].fixes[].edits[].values.maxCallDurationMs | integer | Optional | At least 1000. At most 86400000. |
items[].diagnostics[].fixes[].edits[].values.endCallAfterSilenceMs | integer | Optional | At least 1000. At most 3600000. |
items[].diagnostics[].fixes[].edits[].values.ringDurationMs | integer | Optional | At least 1000. At most 300000. |
items[].diagnostics[].fixes[].edits[].values.beginMessageDelayMs | integer | Optional | At least 0. At most 60000. |
items[].diagnostics[].fixes[].edits[].values.normalizeForSpeech | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.openerWaitsForCallee | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.voicemail | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.voicemail.enabled | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].values.voicemail.detectionTimeoutMs | integer | Optional | Greater than 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].values.voicemail.action | "hangup" · "leave_message" | Optional | — |
items[].diagnostics[].fixes[].edits[].values.voicemail.message | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.voicemail.message.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].values.voicemail.message.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].values.ambientSound | string | Optional | — |
items[].diagnostics[].fixes[].edits[].values.ambientSoundVolume | number | Optional | At least 0. At most 2. |
items[].diagnostics[].fixes[].edits[].values.boostedKeywords | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].values.pronunciationDictionary | array of object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.pronunciationDictionary[].word | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.pronunciationDictionary[].alphabet | "ipa" · "cmu" | Required | — |
items[].diagnostics[].fixes[].edits[].values.pronunciationDictionary[].phoneme | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.denoisingMode | string | Optional | — |
items[].diagnostics[].fixes[].edits[].values.sttMode | string | Optional | — |
items[].diagnostics[].fixes[].edits[].values.allowUserDtmf | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.allowDtmfInterruption | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.userDtmfOptions | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].values.userDtmfOptions.digitLimit | integer or null | Optional | Greater than 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].values.userDtmfOptions.terminationKey | "0" · "1" · "2" · "3" · "4" · "5" · "6" · "7" · "8" · "9" · "*" · "#" or null | Optional | — |
items[].diagnostics[].fixes[].edits[].values.userDtmfOptions.timeoutMs | integer | Optional | Greater than 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].values.dataStorageSetting | "everything" · "everything_except_pii" · "basic_attributes_only" | Optional | — |
items[].diagnostics[].fixes[].edits[].values.optInSignedUrl | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.piiConfig | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.piiConfig.mode | "post_call" | Required | — |
items[].diagnostics[].fixes[].edits[].values.piiConfig.categories | array of "person_name" · "address" · "email" · "phone_number" · "ssn" · "passport" · "driver_license" · "credit_card" · "bank_account" · "password" · "pin" · "medical_id" · "date_of_birth" · "customer_account_number" | Required | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.defaultPersonality | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.conversationalPersonality | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.naturalFillerWords | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.highEmpathy | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.echoVerification | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.natoPhoneticAlphabet | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.speechNormalization | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.smartMatching | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.aiDisclosure | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.handbookConfig.scopeBoundaries | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].values.ivr | object | Optional | — |
| items[].diagnostics[].fixes[].edits[].values.ivr · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.ivr.enabled | false | Required | — |
| items[].diagnostics[].fixes[].edits[].values.ivr · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.ivr.enabled | true | Required | — |
items[].diagnostics[].fixes[].edits[].values.ivr.action | "hangup" | Required | — |
items[].diagnostics[].fixes[].edits[].values.ivr.detectionWindowMs | 180000 | Required | — |
items[].diagnostics[].fixes[].edits[].values.ivr.detectionPrompt | string or null | Optional | — |
items[].diagnostics[].fixes[].edits[].values.screener | object | Optional | — |
| items[].diagnostics[].fixes[].edits[].values.screener · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.screener.action | "hangup" | Required | — |
| items[].diagnostics[].fixes[].edits[].values.screener · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.screener.action | "wait" | Required | — |
items[].diagnostics[].fixes[].edits[].values.screener.waitMs | integer | Optional | At least 5000. At most 120000. |
| items[].diagnostics[].fixes[].edits[].values.screener · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.screener.action | "play_line" | Required | — |
items[].diagnostics[].fixes[].edits[].values.screener.waitMs | integer | Optional | At least 5000. At most 120000. |
items[].diagnostics[].fixes[].edits[].values.screener.line | object | Required | — |
items[].diagnostics[].fixes[].edits[].values.screener.line.en | string | Optional | minLength: 1. maxLength: 500. |
items[].diagnostics[].fixes[].edits[].values.screener.line.es | string | Optional | minLength: 1. maxLength: 500. |
| items[].diagnostics[].fixes[].edits[].values.screener · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].values.screener.action | "treat_as_human" | Required | — |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.model | object | Required | — |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.model.model_id | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.model.provider | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.credential.id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.credential.version | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.postCallAnalysisModel.credential.provider | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].values.compliance | object | Optional | — |
items[].diagnostics[].fixes[].edits[].values.compliance.profile | "fdcpa" | Optional | — |
items[].diagnostics[].fixes[].edits[].clear | array of "voiceId" · "voiceModel" · "voiceSpeed" · "voiceTemperature" · "volume" · "language" · "responsiveness" · "interruptionSensitivity" · "enableBackchannel" · "backchannelFrequency" · "backchannelWords" · "reminderTriggerMs" · "reminderMaxCount" · "maxCallDurationMs" · "endCallAfterSilenceMs" · "ringDurationMs" · "beginMessageDelayMs" · "normalizeForSpeech" · "openerWaitsForCallee" · "voicemail" · "ambientSound" · "ambientSoundVolume" · "boostedKeywords" · "pronunciationDictionary" · "denoisingMode" · "sttMode" · "allowUserDtmf" · "allowDtmfInterruption" · "userDtmfOptions" · "dataStorageSetting" · "optInSignedUrl" · "piiConfig" · "handbookConfig" · "ivr" · "screener" · "postCallAnalysisModel" · "compliance" | Required | — |
| items[].diagnostics[].fixes[].edits[] · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.analysis" | Required | — |
items[].diagnostics[].fixes[].edits[].fields | array of object | Required | — |
items[].diagnostics[].fixes[].edits[].fields[].name | string | Required | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].fields[].type | "string" · "number" · "boolean" · "enum" | Required | — |
items[].diagnostics[].fixes[].edits[].fields[].description | string | Required | — |
items[].diagnostics[].fixes[].edits[].fields[].choices | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].fields[].examples | array of string | Optional | — |
| items[].diagnostics[].fixes[].edits[] · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.provider" | Required | — |
items[].diagnostics[].fixes[].edits[].role | "stt" · "llm" · "tts" | Required | — |
items[].diagnostics[].fixes[].edits[].changes | object | Required | — |
| items[].diagnostics[].fixes[].edits[].changes · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.provider | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.model | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.voiceId | string or null | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.endpoint | string (uri) or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.credential | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].changes.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[].changes · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.model | object | Optional | — |
| items[].diagnostics[].fixes[].edits[].changes.model · combined section 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.model.model_id | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.model.provider | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
items[].diagnostics[].fixes[].edits[].changes.credential | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.provider | "openai" · "simulated_openai" · "self_hosted" · "simulated_self_hosted" | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.endpoint | string (uri) or null | Optional | — |
| items[].diagnostics[].fixes[].edits[] · variant 5 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.telephony" | Required | — |
items[].diagnostics[].fixes[].edits[].value | object | Required | — |
items[].diagnostics[].fixes[].edits[].value.trunkId | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].value.from | string | Optional | pattern: ^+[1-9][0-9]{6,14}$. |
| items[].diagnostics[].fixes[].edits[] · variant 6 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "agent.recording" | Required | — |
items[].diagnostics[].fixes[].edits[].value | object | Required | — |
items[].diagnostics[].fixes[].edits[].value.required | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].value.channels | "dual" | Required | — |
| items[].diagnostics[].fixes[].edits[] · variant 7 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "phone.inbound_context" | Required | — |
items[].diagnostics[].fixes[].edits[].value | object or null | Required | — |
items[].diagnostics[].fixes[].edits[].value.action_id | string | Required in a non-null parent | pattern: ^[a-z][a-z0-9_]{0,62}$. |
items[].diagnostics[].fixes[].edits[].value.variables | array of string | Required in a non-null parent | minItems: 1. maxItems: 256. |
| items[].diagnostics[].fixes[].edits[] · variant 8 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "flow.prompt" | Required | — |
items[].diagnostics[].fixes[].edits[].text | string | Required | — |
| items[].diagnostics[].fixes[].edits[] · variant 9 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.name" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].name | string or null | Required | — |
| items[].diagnostics[].fixes[].edits[] · variant 10 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.instruction" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].instruction | object or null | Required | — |
items[].diagnostics[].fixes[].edits[].instruction.type | "prompt" · "static_text" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].instruction.text | string | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[] · variant 11 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.transitions" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].edges | array of object | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].id | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].edges[].destinationNodeId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition | object | Required | — |
| items[].diagnostics[].fixes[].edits[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].edges[].condition.type | "always" | Required | — |
| items[].diagnostics[].fixes[].edits[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].edges[].condition.type | "conversation_language" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.language | "en" · "es" | Required | — |
| items[].diagnostics[].fixes[].edits[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].edges[].condition.type | "prompt" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.prompt | string | Required | — |
| items[].diagnostics[].fixes[].edits[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].edges[].condition.type | "equation" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.operator | "&&" · "||" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.equations | array of object | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].edges[].condition.equations[].left | string | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].condition.equations[].right | string | Required | — |
items[].diagnostics[].fixes[].edits[].edges[].compliance | object | Optional | — |
items[].diagnostics[].fixes[].edits[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
| items[].diagnostics[].fixes[].edits[] · variant 12 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.configure" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes | object | Required | — |
items[].diagnostics[].fixes[].edits[].changes.name | string or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.instruction | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.instruction.type | "prompt" · "static_text" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.instruction.text | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.startSpeaker | "agent" · "user" or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.interruptionSensitivity | number or null | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].changes.voiceSpeed | number or null | Optional | At least 0.5. At most 2. |
items[].diagnostics[].fixes[].edits[].changes.languageLocked | boolean or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.globalNodeSetting | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.globalNodeSetting.condition | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.globalNodeSetting.coolDown | number | Optional | At least 0. |
items[].diagnostics[].fixes[].edits[].changes.toolId | string or null | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.waitForResult | boolean or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.speakDuringExecution | boolean or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.executionMessage | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.executionMessage.type | "prompt" · "static_text" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.executionMessage.text | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.destination | object | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[].changes.transfer.destination · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.transfer.destination.type | "predefined" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.destination.number | string | Required in a non-null parent | maxLength: 256. |
| items[].diagnostics[].fixes[].edits[].changes.transfer.destination · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.transfer.destination.type | "inferred" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.destination.prompt | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.type | "cold_transfer" · "warm_transfer" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.showTransfereeAsCaller | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.optOutHumanDetection | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.enableBridgeAudioCue | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.onHoldMusic | string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.agentDetectionTimeoutMs | integer | Optional | At least 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.agentDetectionPrompt | string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.transferMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.transferMessage.type | "prompt" · "static_text" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.transferMessage.text | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.privateHandoffMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.privateHandoffMessage.text | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.option.coldTransferMode | string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.transfer.ignoreE164Validation | boolean | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.variables | array of object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.variables[].name | string | Required in a non-null parent | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.variables[].type | "string" · "number" · "boolean" · "enum" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.variables[].description | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.variables[].choices | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.model_id | string | Required in a non-null parent | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.provider | string | Required in a non-null parent | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.type | "cascading" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.highPriority | boolean | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.componentId | string or null | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.verification | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.verification.subjectVariable | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields | array of object | Required in a non-null parent | maxItems: 8. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].id | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].expectedVariable | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].enabledVariable | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format | object | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format.kind | "digits" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format.length | integer | Required in a non-null parent | At least 1. At most 32. |
| items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].format.kind | "date_yyyymmdd" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].prompt | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].prompt.en | string | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.fields[].prompt.es | string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.verification.required | object | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[].changes.verification.required · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.verification.required.kind | "fixed" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.required.count | integer | Required in a non-null parent | At least 1. At most 8. |
| items[].diagnostics[].fixes[].edits[].changes.verification.required · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.verification.required.kind | "variable" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.verification.required.name | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.timeoutMs | integer | Required in a non-null parent | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.toolId | string | Required in a non-null parent | minLength: 1. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.fieldId | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.parameter | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.arguments | array of object | Required in a non-null parent | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.arguments[].parameter | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.verification.lookup.arguments[].variable | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.toolId | string | Required in a non-null parent | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.subjectVariable | string | Required in a non-null parent | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.consentPrompt | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.consentPrompt.en | string | Required in a non-null parent | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.timeoutMs | integer | Required in a non-null parent | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields | array of object | Required in a non-null parent | maxItems: 7. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].id | string | Required in a non-null parent | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].parameter | string | Required in a non-null parent | 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}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].minDigits | integer | Required in a non-null parent | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].maxDigits | integer | Required in a non-null parent | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].encoding | "string" · "integer" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].prompt | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].prompt.en | string | Required in a non-null parent | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments | array of object | Required in a non-null parent | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].parameter | string | Required in a non-null parent | 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}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source | object | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.kind | "variable" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.name | string | Required in a non-null parent | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.kind | "constant" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.value | string or number or boolean or null | Required in a non-null parent | — |
| items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].changes.tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.tokenIdPath | string | Required in a non-null parent | 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}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.tokenVariable | string | Required in a non-null parent | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.last4Variable | string | Required in a non-null parent | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].changes.tokenization.last4Field | string | Required in a non-null parent | maxLength: 64. |
| items[].diagnostics[].fixes[].edits[] · variant 13 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.create" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges | array of object | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].id | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.edges[].destinationNodeId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition | object | Required | — |
| items[].diagnostics[].fixes[].edits[].node.edges[].condition · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.type | "always" | Required | — |
| items[].diagnostics[].fixes[].edits[].node.edges[].condition · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.type | "conversation_language" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.language | "en" · "es" | Required | — |
| items[].diagnostics[].fixes[].edits[].node.edges[].condition · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.type | "prompt" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.prompt | string | Required | — |
| items[].diagnostics[].fixes[].edits[].node.edges[].condition · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.type | "equation" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.operator | "&&" · "||" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.equations | array of object | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.equations[].left | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].condition.equations[].right | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.edges[].compliance | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].node.name | string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.instruction | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.instruction.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].node.instruction.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.startSpeaker | "agent" · "user" | Optional | — |
items[].diagnostics[].fixes[].edits[].node.interruptionSensitivity | number | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].node.voiceSpeed | number | Optional | At least 0.5. At most 2. |
items[].diagnostics[].fixes[].edits[].node.languageLocked | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.globalNodeSetting | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.globalNodeSetting.condition | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.globalNodeSetting.coolDown | number | Optional | At least 0. |
items[].diagnostics[].fixes[].edits[].node.toolId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.waitForResult | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.speakDuringExecution | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.executionMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.executionMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].node.executionMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.destination | object | Required | — |
| items[].diagnostics[].fixes[].edits[].node.transfer.destination · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.transfer.destination.type | "predefined" | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.destination.number | string | Required | maxLength: 256. |
| items[].diagnostics[].fixes[].edits[].node.transfer.destination · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.transfer.destination.type | "inferred" | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.destination.prompt | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.showTransfereeAsCaller | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.optOutHumanDetection | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.enableBridgeAudioCue | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.onHoldMusic | string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.agentDetectionTimeoutMs | integer | Optional | At least 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].node.transfer.option.agentDetectionPrompt | string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.transferMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.transferMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.privateHandoffMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.privateHandoffMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.transfer.option.coldTransferMode | string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.transfer.ignoreE164Validation | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].node.variables | array of object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.variables[].name | string | Required | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
items[].diagnostics[].fixes[].edits[].node.variables[].description | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.variables[].choices | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.model | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].node.modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].node.modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.modelChoice.type | "cascading" | Required | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.highPriority | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].node.modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
items[].diagnostics[].fixes[].edits[].node.componentId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.verification | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.fields | array of object | Required | maxItems: 8. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].format | object | Required | — |
| items[].diagnostics[].fixes[].edits[].node.verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].format.kind | "digits" | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| items[].diagnostics[].fixes[].edits[].node.verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].prompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].prompt.en | string | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.fields[].prompt.es | string | Optional | — |
items[].diagnostics[].fixes[].edits[].node.verification.required | object | Required | — |
| items[].diagnostics[].fixes[].edits[].node.verification.required · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.verification.required.kind | "fixed" | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.required.count | integer | Required | At least 1. At most 8. |
| items[].diagnostics[].fixes[].edits[].node.verification.required · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.verification.required.kind | "variable" | Required | — |
items[].diagnostics[].fixes[].edits[].node.verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.toolId | string | Required | minLength: 1. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.arguments | array of object | Required | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization | object | Optional | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.toolId | string | Required | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node.tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.consentPrompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].node.tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].node.tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields | array of object | Required | maxItems: 7. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].encoding | "string" · "integer" | Required | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].prompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].node.tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments | array of object | Required | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source | object | Required | — |
| items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.kind | "variable" | Required | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.kind | "constant" | Required | — |
items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].node.tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].node.tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].node.tokenization.last4Field | string | Required | maxLength: 64. |
| items[].diagnostics[].fixes[].edits[] · variant 14 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "node.remove" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
| items[].diagnostics[].fixes[].edits[] · variant 15 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "flow.configure" | Required | — |
items[].diagnostics[].fixes[].edits[].changes | object | Required | — |
items[].diagnostics[].fixes[].edits[].changes.startNodeId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.startSpeaker | "agent" · "user" | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.globalPrompt | string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.defaultDynamicVariables | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.defaultDynamicVariables.* | string | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].changes.callContextVariables | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.model_id | string | Required in a non-null parent | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.provider | string | Required in a non-null parent | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.id | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.version | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.credential.provider | string | Required in a non-null parent | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.type | "cascading" | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.highPriority | boolean | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].changes.modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
items[].diagnostics[].fixes[].edits[].changes.toolCallStrictMode | boolean | Optional | — |
| items[].diagnostics[].fixes[].edits[] · variant 16 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "component.create" | Required | — |
items[].diagnostics[].fixes[].edits[].component | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.startNodeId | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes | array of object | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].component.nodes[].id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].kind | "conversation" · "end" · "branch" · "transfer_call" · "function" · "extract_dynamic_variables" · "verify_identity" · "tokenize_private" · "component" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges | array of object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].id | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].destinationNodeId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].slot | "edges" · "else_edge" · "skip_response_edge" · "always_edge" · "edge" · "success_edge" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition | object | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.type | "always" | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.type | "conversation_language" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.language | "en" · "es" | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.type | "prompt" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.prompt | string | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.type | "equation" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.operator | "&&" · "||" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.equations | array of object | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.equations[].left | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.equations[].operator | "==" · "!=" · ">" · "<" · ">=" · "<=" · "contains" · "is_set" · "is_not_set" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].condition.equations[].right | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].compliance | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].edges[].compliance.sets | array of "rpc_confirmed" | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].component.nodes[].name | string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].instruction | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].instruction.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].instruction.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].startSpeaker | "agent" · "user" | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].interruptionSensitivity | number | Optional | At least 0. At most 1. |
items[].diagnostics[].fixes[].edits[].component.nodes[].voiceSpeed | number | Optional | At least 0.5. At most 2. |
items[].diagnostics[].fixes[].edits[].component.nodes[].languageLocked | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].globalNodeSetting | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].globalNodeSetting.condition | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].globalNodeSetting.coolDown | number | Optional | At least 0. |
items[].diagnostics[].fixes[].edits[].component.nodes[].toolId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].waitForResult | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].speakDuringExecution | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].executionMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].executionMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].executionMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination | object | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination.type | "predefined" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination.number | string | Required | maxLength: 256. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination.type | "inferred" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.destination.prompt | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.type | "cold_transfer" · "warm_transfer" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.showTransfereeAsCaller | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.optOutHumanDetection | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.enableBridgeAudioCue | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.onHoldMusic | string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.agentDetectionTimeoutMs | integer | Optional | At least 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.agentDetectionPrompt | string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.transferMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.transferMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.transferMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.privateHandoffMessage | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.privateHandoffMessage.type | "prompt" · "static_text" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.privateHandoffMessage.text | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.option.coldTransferMode | string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].transfer.ignoreE164Validation | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].variables | array of object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].variables[].name | string | Required | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].variables[].type | "string" · "number" · "boolean" · "enum" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].variables[].description | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].variables[].choices | array of string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.model | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.model.model_id | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.model.provider | string | Required | minLength: 1. pattern: \S. |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.model.tier | "frontier" · "cumulus-served" · "customer-gpu" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.credential.id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.credential.version | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.credential.provider | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.type | "cascading" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.highPriority | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].modelChoice.reasoningEffort | "low" · "medium" · "high" | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].componentId | string | Optional | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.subjectVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields | array of object | Required | maxItems: 8. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].expectedVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].privateAliases | array of string | Optional | maxItems: 16. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].enabledVariable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format | object | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format.kind | "digits" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format.length | integer | Required | At least 1. At most 32. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].format.kind | "date_yyyymmdd" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].prompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].prompt.en | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.fields[].prompt.es | string | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required | object | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required.kind | "fixed" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required.count | integer | Required | At least 1. At most 8. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required.kind | "variable" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.required.name | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.timeoutMs | integer | Required | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.toolId | string | Required | minLength: 1. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.fieldId | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.arguments | array of object | Required | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.arguments[].parameter | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].verification.lookup.arguments[].variable | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.toolId | string | Required | maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.subjectVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.consentPrompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.consentPrompt.en | string | Required | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.consentPrompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.timeoutMs | integer | Required | At least 1000. At most 180000. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields | array of object | Required | maxItems: 7. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].id | string | Required | pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].minDigits | integer | Required | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].maxDigits | integer | Required | At least 1. At most 32. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].encoding | "string" · "integer" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].minimum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].maximum | integer | Optional | At least 0. At most 999999999. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].prompt | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].prompt.en | string | Required | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.fields[].prompt.es | string | Optional | maxLength: 4096. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments | array of object | Required | maxItems: 64. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].parameter | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source | object | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.kind | "variable" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.name | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.kind | "constant" | Required | — |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.value | string or number or boolean or null | Required | — |
| items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.value · variant 1 | string | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.value · variant 2 | number | — | Fields for this schema branch. |
| items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.arguments[].source.value · variant 3 | boolean | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.tokenIdPath | string | Required | maxLength: 256. pattern: ^(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_](?:.(?!(?:proto|constructor|prototype)(?:.|$))[A-Za-z_][A-Za-z0-9_]){0,7}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.tokenVariable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.last4Variable | string | Required | pattern: ^(?!(?:proto|constructor|prototype)$)[A-Za-z_][A-Za-z0-9_]{0,255}$. |
items[].diagnostics[].fixes[].edits[].component.nodes[].tokenization.last4Field | string | Required | maxLength: 64. |
items[].diagnostics[].fixes[].edits[].component.tools | array of object | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].name | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.tools[].description | string | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].url | string (uri) | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].parameters | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].parameters.* | any JSON value | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].component.tools[].responseVariables | object | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].responseVariables.* | string | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].component.tools[].timeoutMs | integer | Required | Greater than 0. At most 9007199254740991. |
items[].diagnostics[].fixes[].edits[].component.tools[].responseVariablePolicy | "required" · "replace_available" | Optional | — |
items[].diagnostics[].fixes[].edits[].component.tools[].argsAtRoot | boolean | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].parameterType | "json" | Required | — |
items[].diagnostics[].fixes[].edits[].component.tools[].speakAfterExecution | boolean | Optional | — |
items[].diagnostics[].fixes[].edits[].component.tools[].id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].component.tools[].credential | object | Optional | — |
items[].diagnostics[].fixes[].edits[].component.tools[].credential.id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
items[].diagnostics[].fixes[].edits[].component.tools[].credential.version | string | Required | pattern: ^[a-f0-9]{64}$. |
items[].diagnostics[].fixes[].edits[].component.flexMode | boolean | Optional | — |
| items[].diagnostics[].fixes[].edits[] · variant 17 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "component.start" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].start_node_id | string | Required | minLength: 1. maxLength: 256. |
| items[].diagnostics[].fixes[].edits[] · variant 18 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "component.remove" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string | Required | minLength: 1. maxLength: 256. |
| items[].diagnostics[].fixes[].edits[] · variant 19 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "transfer.credential" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].node_id | string | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].credential | object | Required | — |
| items[].diagnostics[].fixes[].edits[].credential · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].credential.action | "keep" | Required | — |
| items[].diagnostics[].fixes[].edits[].credential · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].credential.action | "replace" | Required | — |
items[].diagnostics[].fixes[].edits[].credential.reference | object | Required | — |
items[].diagnostics[].fixes[].edits[].credential.reference.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].credential.reference.version | string | Required | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[].credential · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].credential.action | "remove" | Required | — |
items[].diagnostics[].fixes[].edits[].clear_inline | boolean | Required | — |
| items[].diagnostics[].fixes[].edits[] · variant 20 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "channels.set" | Required | — |
items[].diagnostics[].fixes[].edits[].channels | array of "cloud" · "phone" | Required | minItems: 1. maxItems: 2. |
| items[].diagnostics[].fixes[].edits[] · variant 21 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "languages.set" | Required | — |
items[].diagnostics[].fixes[].edits[].languages | array of "en" · "es" | Required | minItems: 1. maxItems: 2. |
| items[].diagnostics[].fixes[].edits[] · variant 22 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "trigger.put" | Required | — |
items[].diagnostics[].fixes[].edits[].trigger | object | Required | — |
| items[].diagnostics[].fixes[].edits[].trigger · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].trigger.kind | "schedule" | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].trigger.cron | string | Required | pattern: ^(\S+\s+){4}\S+$. |
items[].diagnostics[].fixes[].edits[].trigger.timezone | string | Required | minLength: 1. maxLength: 64. |
items[].diagnostics[].fixes[].edits[].trigger.input | object | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.input.* | any JSON value | Optional | Additional keys are allowed. |
| items[].diagnostics[].fixes[].edits[].trigger · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].trigger.kind | "event" | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].trigger.event_type | "run.ended" · "analysis.updated" | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.source | object | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.source.agent_id | string | Optional | Agent identifier in the environment selected by your API key. minLength: 1. maxLength: 256. pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$. |
items[].diagnostics[].fixes[].edits[].trigger.source.channel | "cloud" · "phone" · "web" | Optional | — |
items[].diagnostics[].fixes[].edits[].trigger.source.dispositions | array of string | Optional | maxItems: 32. |
items[].diagnostics[].fixes[].edits[].trigger.input_mapping | object | Required | — |
items[].diagnostics[].fixes[].edits[].trigger.input_mapping.* | string | Optional | Additional keys are allowed. |
| items[].diagnostics[].fixes[].edits[] · variant 23 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "trigger.remove" | Required | — |
items[].diagnostics[].fixes[].edits[].trigger_id | string | Required | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[] · variant 24 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "action.put" | Required | — |
items[].diagnostics[].fixes[].edits[].action | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.purpose | "tokenization" | Optional | — |
items[].diagnostics[].fixes[].edits[].action.name | string | Required | pattern: ^[a-z][a-z0-9_]{0,62}$. |
items[].diagnostics[].fixes[].edits[].action.description | string | Required | minLength: 1. maxLength: 1024. |
items[].diagnostics[].fixes[].edits[].action.channels | array of "cloud" · "phone" | Required | minItems: 1. |
items[].diagnostics[].fixes[].edits[].action.method | "GET" · "POST" · "PUT" · "PATCH" · "DELETE" | Required | — |
items[].diagnostics[].fixes[].edits[].action.url | string (uri) | Required | — |
items[].diagnostics[].fixes[].edits[].action.headers | object | Optional | Default: {}. |
items[].diagnostics[].fixes[].edits[].action.headers.* | string | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].action.auth | object | Required | — |
| items[].diagnostics[].fixes[].edits[].action.auth · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.auth.scheme | "none" | Required | — |
| items[].diagnostics[].fixes[].edits[].action.auth · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.auth.scheme | "bearer" · "basic" | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[].action.auth · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.auth.scheme | "retell_signature" | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[].action.auth · variant 4 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.auth.scheme | "header" | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.header_name | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].action.auth.secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].action.input_schema | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.input_schema.* | any JSON value | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].action.output_schema | object | Required | — |
items[].diagnostics[].fixes[].edits[].action.output_schema.* | any JSON value | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].action.idempotency | object | Required | — |
| items[].diagnostics[].fixes[].edits[].action.idempotency · variant 1 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.idempotency.mode | "effect_key" | Required | — |
| items[].diagnostics[].fixes[].edits[].action.idempotency · variant 2 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.idempotency.mode | "template" | Required | — |
items[].diagnostics[].fixes[].edits[].action.idempotency.header | string | Optional | Default: "Idempotency-Key". |
items[].diagnostics[].fixes[].edits[].action.idempotency.template | string | Required | minLength: 1. maxLength: 512. |
| items[].diagnostics[].fixes[].edits[].action.idempotency · variant 3 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].action.idempotency.mode | "none_read_only" | Required | — |
items[].diagnostics[].fixes[].edits[].action.timeout_ms | integer | Required | At least 500. At most 120000. |
items[].diagnostics[].fixes[].edits[].action.on_uncertain | "failure_edge" · "uncertain_edge" | Optional | Default: "failure_edge". |
items[].diagnostics[].fixes[].edits[].response_variables | object | Optional | Flow variables set from the action's 2xx JSON response, name to path ($.account.balance). Omitted keeps the current ones; {} removes them. |
items[].diagnostics[].fixes[].edits[].response_variables.* | string | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].response_variable_policy | "required" · "replace_available" | Optional | Required (default) rejects missing mapped outputs. Replace_available replaces the mapped variable set with present scalar outputs and clears missing/null values, for conditional lookup responses. Objects and arrays are rejected in both modes. Omitted preserves the current policy. |
items[].diagnostics[].fixes[].edits[].speak_after_execution | boolean | Optional | Generate a spoken response after the action result. False continues routing without an extra reply; omitted preserves the current setting. |
| items[].diagnostics[].fixes[].edits[] · variant 25 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "action.remove" | Required | — |
items[].diagnostics[].fixes[].edits[].name | string | Required | pattern: ^[a-z][a-z0-9_]{0,62}$. |
| items[].diagnostics[].fixes[].edits[] · variant 26 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "notification.put" | Required | — |
items[].diagnostics[].fixes[].edits[].notification | object | Required | — |
items[].diagnostics[].fixes[].edits[].notification.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].notification.url | string (uri) | Required | — |
items[].diagnostics[].fixes[].edits[].notification.secret_ref | object | Required | — |
items[].diagnostics[].fixes[].edits[].notification.secret_ref.id | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].notification.secret_ref.version | string | Required | minLength: 1. maxLength: 128. |
items[].diagnostics[].fixes[].edits[].notification.format | "semantic.v1" | Required | — |
items[].diagnostics[].fixes[].edits[].notification.events | array of "run.admitted" · "run.ended" · "recording.updated" · "analysis.updated" | Required | minItems: 1. |
| items[].diagnostics[].fixes[].edits[] · variant 27 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "notification.remove" | Required | — |
items[].diagnostics[].fixes[].edits[].notification_id | string | Required | minLength: 1. maxLength: 128. |
| items[].diagnostics[].fixes[].edits[] · variant 28 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "knowledge.set" | Required | — |
items[].diagnostics[].fixes[].edits[].document_ids | array of string (uuid) or null | Required | minItems: 1. maxItems: 200. |
| items[].diagnostics[].fixes[].edits[] · variant 29 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "cloud.io.set" | Required | — |
items[].diagnostics[].fixes[].edits[].cloud | object or null | Required | — |
items[].diagnostics[].fixes[].edits[].cloud.modes | array of "task" · "chat" · "background" | Required in a non-null parent | minItems: 1. |
items[].diagnostics[].fixes[].edits[].cloud.input_schema | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].cloud.input_schema.* | any JSON value | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].cloud.output_schema | object | Required in a non-null parent | — |
items[].diagnostics[].fixes[].edits[].cloud.output_schema.* | any JSON value | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].cloud.max_turns | integer | Required in a non-null parent | At least 1. At most 200. |
items[].diagnostics[].fixes[].edits[].cloud.idle_timeout_ms | integer | Required in a non-null parent | At least 10000. At most 86400000. |
items[].diagnostics[].fixes[].edits[].cloud.deadline_ms | integer | Required in a non-null parent | At least 1000. At most 3600000. |
| items[].diagnostics[].fixes[].edits[] · variant 30 | object | — | Fields for this schema branch. |
items[].diagnostics[].fixes[].edits[].type | "layout.set" | Required | — |
items[].diagnostics[].fixes[].edits[].component_id | string or null | Required | minLength: 1. maxLength: 256. |
items[].diagnostics[].fixes[].edits[].nodes | object | Optional | — |
items[].diagnostics[].fixes[].edits[].nodes.* | object or null | Optional | Additional keys are allowed. |
items[].diagnostics[].fixes[].edits[].start | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].start.x | number | Required in a non-null parent | At least -10000000. At most 10000000. |
items[].diagnostics[].fixes[].edits[].start.y | number | Required in a non-null parent | At least -10000000. At most 10000000. |
items[].diagnostics[].fixes[].edits[].viewport | object or null | Optional | — |
items[].diagnostics[].fixes[].edits[].viewport.x | number | Required in a non-null parent | At least -10000000. At most 10000000. |
items[].diagnostics[].fixes[].edits[].viewport.y | number | Required in a non-null parent | At least -10000000. At most 10000000. |
items[].diagnostics[].fixes[].edits[].viewport.zoom | number | Required in a non-null parent | At least 0.01. At most 100. |
items[].trials | array of object | Required | maxItems: 30. |
items[].trials[].case_id | string | Required | minLength: 1. maxLength: 64. pattern: ^[a-z0-9][a-z0-9_-]*$. |
items[].trials[].trial | integer | Required | Greater than 0. At most 9007199254740991. |
items[].trials[].attempt | integer | Required | Greater than 0. At most 9007199254740991. |
items[].trials[].run_id | string (uuid) or null | Required | Run identifier returned when the run was admitted. 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})$. |
items[].trials[].state | "pending" · "running" · "evaluating" · "settled" · "cancelled" | Required | — |
items[].trials[].verdict | "passed" · "failed" · "errored" or null | Required | — |
items[].trials[].reason | string or null | Required | pattern: ^[a-z][a-z0-9_.:-]{0,127}$. |
items[].trials[].assertions | array of object | Required | maxItems: 25. |
items[].trials[].assertions[].assertion_id | string | Required | minLength: 1. maxLength: 64. pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$. |
items[].trials[].assertions[].type | string | Required | minLength: 1. maxLength: 64. |
items[].trials[].assertions[].verdict | "passed" · "failed" · "not_applicable" · "insufficient_data" · "errored" | Required | — |
items[].trials[].assertions[].measured | object | Required | — |
items[].trials[].assertions[].measured.* | string or number or boolean or null | Optional | Additional keys are allowed. |
items[].trials[].assertions[].evidence | object | Required | — |
items[].trials[].assertions[].evidence.turns | array of integer | Required | maxItems: 50. |
items[].trials[].assertions[].evidence.node_ids | array of string | Required | maxItems: 50. |
items[].trials[].assertions[].evidence.effect_ids | array of string (uuid) | Required | maxItems: 20. |
items[].trials[].assertions[].judge | object or null | Required | — |
items[].trials[].assertions[].judge.score | number | Required in a non-null parent | At least 0. At most 1. |
items[].trials[].assertions[].judge.rejudged | boolean | Required in a non-null parent | — |
items[].trials[].assertions[].judge.criteria | array of object | Required in a non-null parent | maxItems: 12. |
items[].trials[].assertions[].judge.criteria[].id | string | Required in a non-null parent | minLength: 1. maxLength: 64. |
items[].trials[].assertions[].judge.criteria[].verdict | "pass" · "fail" · "na" | Required in a non-null parent | — |
items[].trials[].assertions[].judge.criteria[].score | integer or null | Required in a non-null parent | At least 1. At most 5. |
items[].trials[].assertions[].judge.criteria[].evidence_turns | array of integer | Required in a non-null parent | maxItems: 20. |
items[].trials[].assertions[].judge.criteria[].rationale | string or null | Required in a non-null parent | maxLength: 300. |
items[].trials[].assertions[].reason | string or null | Required | pattern: ^[a-z][a-z0-9_.:-]{0,127}$. |
items[].trials[].guard | object | Required | — |
items[].trials[].guard.compliance_blocks | object | Required | — |
items[].trials[].guard.compliance_blocks.* | integer | Optional | Additional keys are allowed. |
items[].trials[].guard.rpc_unconfirmed | integer | Required | At least 0. At most 9007199254740991. |
items[].trials[].guard.atomic_half_said | integer | Required | At least 0. At most 9007199254740991. |
items[].trials[].content_state | "retained" · "expired" | Required | — |
next_cursor | string or null | Required | Cursor for the next page; null when no next page exists. |
Error responses
| HTTP | Description |
|---|---|
| 4XX | Typed error (ApiError) |
| 5XX | Typed error (ApiError) |
Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.
Complete OpenAPI schema
{
"200": {
"description": "List a test run's case results with each trial's assertion verdicts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestRunsResultsResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
Expand the complete OpenAPI definitions for integrations that generate their own clients.
Complete OpenAPI schema
{
"components": {
"schemas": {
"TestRunsResultsResponse200": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"suite_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})$"
},
"case_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z0-9][a-z0-9_-]*$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"verdict": {
"nullable": true,
"type": "string",
"enum": [
"passed",
"flaky_passed",
"failed",
"errored",
"invalid"
]
},
"change": {
"nullable": true,
"type": "string",
"enum": [
"fixed",
"regressed",
"unchanged",
"new",
"removed"
]
},
"blocking": {
"type": "boolean"
},
"diagnostics": {
"maxItems": 50,
"type": "array",
"items": {
"$ref": "#/components/schemas/Diagnostic"
}
},
"trials": {
"maxItems": 30,
"type": "array",
"items": {
"$ref": "#/components/schemas/TrialResult"
}
}
},
"required": [
"suite_id",
"case_id",
"name",
"verdict",
"change",
"blocking",
"diagnostics",
"trials"
],
"additionalProperties": false
}
},
"next_cursor": {
"nullable": true,
"type": "string"
}
},
"required": [
"items",
"next_cursor"
],
"additionalProperties": false
},
"Diagnostic": {
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"path": {
"type": "string",
"maxLength": 1024
},
"message": {
"type": "string",
"maxLength": 4096
},
"severity": {
"type": "string",
"enum": [
"warning",
"error"
]
},
"fixes": {
"maxItems": 8,
"type": "array",
"items": {
"$ref": "#/components/schemas/DiagnosticFix"
}
}
},
"required": [
"code",
"path",
"message",
"severity"
],
"additionalProperties": false
},
"DiagnosticFix": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"edits": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/components/schemas/DraftEdit"
}
}
},
"required": [
"id",
"label",
"edits"
],
"additionalProperties": false
},
"DraftEdit": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.name"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.settings"
]
},
"values": {
"type": "object",
"properties": {
"voiceId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"voiceModel": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"voiceSpeed": {
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"voiceTemperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"volume": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
]
},
"responsiveness": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"interruptionSensitivity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"enableBackchannel": {
"type": "boolean"
},
"backchannelFrequency": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"backchannelWords": {
"type": "array",
"items": {
"type": "string"
}
},
"reminderTriggerMs": {
"type": "integer",
"minimum": 0,
"maximum": 3600000
},
"reminderMaxCount": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"maxCallDurationMs": {
"type": "integer",
"minimum": 1000,
"maximum": 86400000
},
"endCallAfterSilenceMs": {
"type": "integer",
"minimum": 1000,
"maximum": 3600000
},
"ringDurationMs": {
"type": "integer",
"minimum": 1000,
"maximum": 300000
},
"beginMessageDelayMs": {
"type": "integer",
"minimum": 0,
"maximum": 60000
},
"normalizeForSpeech": {
"type": "boolean"
},
"openerWaitsForCallee": {
"type": "boolean"
},
"voicemail": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"detectionTimeoutMs": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"enum": [
"hangup",
"leave_message"
]
},
"message": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
"ambientSound": {
"type": "string"
},
"ambientSoundVolume": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"boostedKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"pronunciationDictionary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"word": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"alphabet": {
"type": "string",
"enum": [
"ipa",
"cmu"
]
},
"phoneme": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"word",
"alphabet",
"phoneme"
],
"additionalProperties": false
}
},
"denoisingMode": {
"type": "string"
},
"sttMode": {
"type": "string"
},
"allowUserDtmf": {
"type": "boolean"
},
"allowDtmfInterruption": {
"type": "boolean"
},
"userDtmfOptions": {
"nullable": true,
"type": "object",
"properties": {
"digitLimit": {
"nullable": true,
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"terminationKey": {
"nullable": true,
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"*",
"#"
]
},
"timeoutMs": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"dataStorageSetting": {
"type": "string",
"enum": [
"everything",
"everything_except_pii",
"basic_attributes_only"
]
},
"optInSignedUrl": {
"type": "boolean"
},
"piiConfig": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"post_call"
]
},
"categories": {
"type": "array",
"items": {
"type": "string",
"enum": [
"person_name",
"address",
"email",
"phone_number",
"ssn",
"passport",
"driver_license",
"credit_card",
"bank_account",
"password",
"pin",
"medical_id",
"date_of_birth",
"customer_account_number"
]
}
}
},
"required": [
"mode",
"categories"
],
"additionalProperties": false
},
"handbookConfig": {
"type": "object",
"properties": {
"defaultPersonality": {
"type": "boolean"
},
"conversationalPersonality": {
"type": "boolean"
},
"naturalFillerWords": {
"type": "boolean"
},
"highEmpathy": {
"type": "boolean"
},
"echoVerification": {
"type": "boolean"
},
"natoPhoneticAlphabet": {
"type": "boolean"
},
"speechNormalization": {
"type": "boolean"
},
"smartMatching": {
"type": "boolean"
},
"aiDisclosure": {
"type": "boolean"
},
"scopeBoundaries": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ivr": {
"oneOf": [
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"enum": [
false
]
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"enum": [
true
]
},
"action": {
"type": "string",
"enum": [
"hangup"
]
},
"detectionWindowMs": {
"type": "number",
"enum": [
180000
]
},
"detectionPrompt": {
"nullable": true,
"type": "string"
}
},
"required": [
"enabled",
"action",
"detectionWindowMs"
],
"additionalProperties": false
}
]
},
"screener": {
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"hangup"
]
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"wait"
]
},
"waitMs": {
"type": "integer",
"minimum": 5000,
"maximum": 120000
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"play_line"
]
},
"waitMs": {
"type": "integer",
"minimum": 5000,
"maximum": 120000
},
"line": {
"type": "object",
"properties": {
"en": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"es": {
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"additionalProperties": false
}
},
"required": [
"action",
"line"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"treat_as_human"
]
}
},
"required": [
"action"
],
"additionalProperties": false
}
]
},
"postCallAnalysisModel": {
"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
}
},
"required": [
"model"
],
"additionalProperties": false
},
"compliance": {
"type": "object",
"properties": {
"profile": {
"type": "string",
"enum": [
"fdcpa"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"clear": {
"type": "array",
"items": {
"type": "string",
"enum": [
"voiceId",
"voiceModel",
"voiceSpeed",
"voiceTemperature",
"volume",
"language",
"responsiveness",
"interruptionSensitivity",
"enableBackchannel",
"backchannelFrequency",
"backchannelWords",
"reminderTriggerMs",
"reminderMaxCount",
"maxCallDurationMs",
"endCallAfterSilenceMs",
"ringDurationMs",
"beginMessageDelayMs",
"normalizeForSpeech",
"openerWaitsForCallee",
"voicemail",
"ambientSound",
"ambientSoundVolume",
"boostedKeywords",
"pronunciationDictionary",
"denoisingMode",
"sttMode",
"allowUserDtmf",
"allowDtmfInterruption",
"userDtmfOptions",
"dataStorageSetting",
"optInSignedUrl",
"piiConfig",
"handbookConfig",
"ivr",
"screener",
"postCallAnalysisModel",
"compliance"
]
}
}
},
"required": [
"type",
"values",
"clear"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.analysis"
]
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean",
"enum"
]
},
"description": {
"type": "string"
},
"choices": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"type",
"description"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"fields"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.provider"
]
},
"role": {
"type": "string",
"enum": [
"stt",
"llm",
"tts"
]
},
"changes": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"voiceId": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"endpoint": {
"nullable": true,
"type": "string",
"format": "uri"
},
"credential": {
"nullable": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"model": {
"allOf": [
{
"$ref": "#/components/schemas/ModelIdentity"
}
]
},
"credential": {
"nullable": true,
"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
},
"provider": {
"type": "string",
"enum": [
"openai",
"simulated_openai",
"self_hosted",
"simulated_self_hosted"
]
},
"endpoint": {
"nullable": true,
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
]
}
},
"required": [
"type",
"role",
"changes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.telephony"
]
},
"value": {
"type": "object",
"properties": {
"trunkId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"from": {
"type": "string",
"pattern": "^\\+[1-9][0-9]{6,14}$"
}
},
"required": [
"trunkId"
],
"additionalProperties": false
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"agent.recording"
]
},
"value": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"channels": {
"type": "string",
"enum": [
"dual"
]
}
},
"required": [
"required",
"channels"
],
"additionalProperties": false
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"phone.inbound_context"
]
},
"value": {
"nullable": true,
"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
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"flow.prompt"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.name"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"name": {
"nullable": true,
"type": "string"
}
},
"required": [
"type",
"component_id",
"node_id",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.instruction"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"instruction": {
"nullable": true,
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
},
"required": [
"type",
"component_id",
"node_id",
"instruction"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.transitions"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"destinationNodeId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
]
},
"compliance": {
"type": "object",
"properties": {
"sets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"rpc_confirmed"
]
}
}
},
"required": [
"sets"
],
"additionalProperties": false
}
},
"required": [
"slot",
"condition"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"component_id",
"node_id",
"edges"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.configure"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"changes": {
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"instruction": {
"nullable": true,
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"startSpeaker": {
"nullable": true,
"type": "string",
"enum": [
"agent",
"user"
]
},
"interruptionSensitivity": {
"nullable": true,
"type": "number",
"minimum": 0,
"maximum": 1
},
"voiceSpeed": {
"nullable": true,
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"languageLocked": {
"nullable": true,
"type": "boolean"
},
"globalNodeSetting": {
"nullable": true,
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"coolDown": {
"type": "number",
"minimum": 0
}
},
"required": [
"condition"
],
"additionalProperties": false
},
"toolId": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"waitForResult": {
"nullable": true,
"type": "boolean"
},
"speakDuringExecution": {
"nullable": true,
"type": "boolean"
},
"executionMessage": {
"nullable": true,
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"transfer": {
"nullable": true,
"type": "object",
"properties": {
"destination": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"predefined"
]
},
"number": {
"type": "string",
"maxLength": 256
}
},
"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": 0,
"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
},
"ignoreE164Validation": {
"type": "boolean"
}
},
"required": [
"destination",
"option",
"ignoreE164Validation"
],
"additionalProperties": false
},
"variables": {
"nullable": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean",
"enum"
]
},
"description": {
"type": "string"
},
"choices": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"type",
"description"
],
"additionalProperties": false
}
},
"modelChoice": {
"nullable": true,
"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
},
"componentId": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"verification": {
"nullable": true,
"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": {
"nullable": true,
"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
}
},
"additionalProperties": false
}
},
"required": [
"type",
"component_id",
"node_id",
"changes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.create"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"kind": {
"type": "string",
"enum": [
"conversation",
"end",
"branch",
"transfer_call",
"function",
"extract_dynamic_variables",
"verify_identity",
"tokenize_private",
"component"
]
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"destinationNodeId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
]
},
"compliance": {
"type": "object",
"properties": {
"sets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"rpc_confirmed"
]
}
}
},
"required": [
"sets"
],
"additionalProperties": false
}
},
"required": [
"slot",
"condition"
],
"additionalProperties": false
}
},
"name": {
"type": "string"
},
"instruction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"startSpeaker": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"interruptionSensitivity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"voiceSpeed": {
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"languageLocked": {
"type": "boolean"
},
"globalNodeSetting": {
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"coolDown": {
"type": "number",
"minimum": 0
}
},
"required": [
"condition"
],
"additionalProperties": false
},
"toolId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"waitForResult": {
"type": "boolean"
},
"speakDuringExecution": {
"type": "boolean"
},
"executionMessage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"transfer": {
"type": "object",
"properties": {
"destination": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"predefined"
]
},
"number": {
"type": "string",
"maxLength": 256
}
},
"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": 0,
"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
},
"ignoreE164Validation": {
"type": "boolean"
}
},
"required": [
"destination",
"option",
"ignoreE164Validation"
],
"additionalProperties": false
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"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
},
"componentId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
},
"required": [
"id",
"kind",
"edges"
],
"additionalProperties": false
}
},
"required": [
"type",
"component_id",
"node"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"node.remove"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"type",
"component_id",
"node_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"flow.configure"
]
},
"changes": {
"type": "object",
"properties": {
"startNodeId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"startSpeaker": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"globalPrompt": {
"type": "string"
},
"defaultDynamicVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"callContextVariables": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"modelChoice": {
"nullable": true,
"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"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"changes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"component.create"
]
},
"component": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"startNodeId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"nodes": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"kind": {
"type": "string",
"enum": [
"conversation",
"end",
"branch",
"transfer_call",
"function",
"extract_dynamic_variables",
"verify_identity",
"tokenize_private",
"component"
]
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"destinationNodeId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
]
},
"compliance": {
"type": "object",
"properties": {
"sets": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"rpc_confirmed"
]
}
}
},
"required": [
"sets"
],
"additionalProperties": false
}
},
"required": [
"slot",
"condition"
],
"additionalProperties": false
}
},
"name": {
"type": "string"
},
"instruction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"startSpeaker": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"interruptionSensitivity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"voiceSpeed": {
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"languageLocked": {
"type": "boolean"
},
"globalNodeSetting": {
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"coolDown": {
"type": "number",
"minimum": 0
}
},
"required": [
"condition"
],
"additionalProperties": false
},
"toolId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"waitForResult": {
"type": "boolean"
},
"speakDuringExecution": {
"type": "boolean"
},
"executionMessage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"prompt",
"static_text"
]
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
"transfer": {
"type": "object",
"properties": {
"destination": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"predefined"
]
},
"number": {
"type": "string",
"maxLength": 256
}
},
"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": 0,
"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
},
"ignoreE164Validation": {
"type": "boolean"
}
},
"required": [
"destination",
"option",
"ignoreE164Validation"
],
"additionalProperties": false
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"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
},
"componentId": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
},
"required": [
"id",
"kind",
"edges"
],
"additionalProperties": false
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"description": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"parameters": {
"type": "object",
"additionalProperties": {}
},
"responseVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeoutMs": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"responseVariablePolicy": {
"type": "string",
"enum": [
"required",
"replace_available"
]
},
"argsAtRoot": {
"type": "boolean"
},
"parameterType": {
"type": "string",
"enum": [
"json"
]
},
"speakAfterExecution": {
"type": "boolean"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"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
}
},
"required": [
"name",
"description",
"url",
"method",
"parameters",
"responseVariables",
"timeoutMs",
"argsAtRoot",
"parameterType",
"id"
],
"additionalProperties": false
}
},
"flexMode": {
"type": "boolean"
}
},
"required": [
"id",
"startNodeId",
"nodes",
"tools"
],
"additionalProperties": false
}
},
"required": [
"type",
"component"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"component.start"
]
},
"component_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"start_node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"type",
"component_id",
"start_node_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"component.remove"
]
},
"component_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"type",
"component_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"transfer.credential"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"node_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"credential": {
"oneOf": [
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"keep"
]
}
},
"required": [
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"replace"
]
},
"reference": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"required": [
"action",
"reference"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"remove"
]
}
},
"required": [
"action"
],
"additionalProperties": false
}
]
},
"clear_inline": {
"type": "boolean"
}
},
"required": [
"type",
"component_id",
"node_id",
"credential",
"clear_inline"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"channels.set"
]
},
"channels": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"cloud",
"phone"
]
}
}
},
"required": [
"type",
"channels"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"languages.set"
]
},
"languages": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"en",
"es"
]
}
}
},
"required": [
"type",
"languages"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"trigger.put"
]
},
"trigger": {
"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
}
]
}
},
"required": [
"type",
"trigger"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"trigger.remove"
]
},
"trigger_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"type",
"trigger_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"action.put"
]
},
"action": {
"type": "object",
"properties": {
"purpose": {
"type": "string",
"enum": [
"tokenization"
]
},
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,62}$"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"cloud",
"phone"
]
}
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"url": {
"type": "string",
"format": "uri"
},
"headers": {
"default": {},
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 1024
}
},
"auth": {
"oneOf": [
{
"type": "object",
"properties": {
"scheme": {
"type": "string",
"enum": [
"none"
]
}
},
"required": [
"scheme"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scheme": {
"type": "string",
"enum": [
"bearer",
"basic"
]
},
"secret_ref": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"required": [
"scheme",
"secret_ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scheme": {
"type": "string",
"enum": [
"retell_signature"
]
},
"secret_ref": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"required": [
"scheme",
"secret_ref"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"scheme": {
"type": "string",
"enum": [
"header"
]
},
"header_name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"secret_ref": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
}
},
"required": [
"scheme",
"header_name",
"secret_ref"
],
"additionalProperties": false
}
]
},
"input_schema": {
"type": "object",
"additionalProperties": {}
},
"output_schema": {
"type": "object",
"additionalProperties": {}
},
"idempotency": {
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"effect_key"
]
}
},
"required": [
"mode"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"template"
]
},
"header": {
"default": "Idempotency-Key",
"type": "string"
},
"template": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"mode",
"template"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"none_read_only"
]
}
},
"required": [
"mode"
],
"additionalProperties": false
}
]
},
"timeout_ms": {
"type": "integer",
"minimum": 500,
"maximum": 120000
},
"on_uncertain": {
"default": "failure_edge",
"type": "string",
"enum": [
"failure_edge",
"uncertain_edge"
]
}
},
"required": [
"name",
"description",
"channels",
"method",
"url",
"auth",
"input_schema",
"output_schema",
"idempotency",
"timeout_ms"
],
"additionalProperties": false
},
"response_variables": {
"description": "Flow variables set from the action's 2xx JSON response, name to path ($.account.balance). Omitted keeps the current ones; {} removes them.",
"type": "object",
"additionalProperties": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"response_variable_policy": {
"description": "Required (default) rejects missing mapped outputs. Replace_available replaces the mapped variable set with present scalar outputs and clears missing/null values, for conditional lookup responses. Objects and arrays are rejected in both modes. Omitted preserves the current policy.",
"type": "string",
"enum": [
"required",
"replace_available"
]
},
"speak_after_execution": {
"description": "Generate a spoken response after the action result. False continues routing without an extra reply; omitted preserves the current setting.",
"type": "boolean"
}
},
"required": [
"type",
"action"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"action.remove"
]
},
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,62}$"
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"notification.put"
]
},
"notification": {
"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
}
},
"required": [
"type",
"notification"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"notification.remove"
]
},
"notification_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"type",
"notification_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"knowledge.set"
]
},
"document_ids": {
"nullable": true,
"minItems": 1,
"maxItems": 200,
"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})$"
}
}
},
"required": [
"type",
"document_ids"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cloud.io.set"
]
},
"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
}
},
"required": [
"type",
"cloud"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"layout.set"
]
},
"component_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 256
},
"nodes": {
"type": "object",
"additionalProperties": {
"nullable": true,
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
}
},
"start": {
"nullable": true,
"type": "object",
"properties": {
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
"viewport": {
"nullable": true,
"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": [
"type",
"component_id"
],
"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
},
"TrialResult": {
"type": "object",
"properties": {
"case_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z0-9][a-z0-9_-]*$"
},
"trial": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"attempt": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
},
"run_id": {
"nullable": true,
"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})$"
},
"state": {
"type": "string",
"enum": [
"pending",
"running",
"evaluating",
"settled",
"cancelled"
]
},
"verdict": {
"nullable": true,
"type": "string",
"enum": [
"passed",
"failed",
"errored"
]
},
"reason": {
"nullable": true,
"type": "string",
"pattern": "^[a-z][a-z0-9_.:-]{0,127}$"
},
"assertions": {
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"assertion_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]*$"
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"verdict": {
"type": "string",
"enum": [
"passed",
"failed",
"not_applicable",
"insufficient_data",
"errored"
]
},
"measured": {
"type": "object",
"additionalProperties": {
"nullable": true,
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"evidence": {
"type": "object",
"properties": {
"turns": {
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"node_ids": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"effect_ids": {
"maxItems": 20,
"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})$"
}
}
},
"required": [
"turns",
"node_ids",
"effect_ids"
],
"additionalProperties": false
},
"judge": {
"nullable": true,
"type": "object",
"properties": {
"score": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"rejudged": {
"type": "boolean"
},
"criteria": {
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"verdict": {
"type": "string",
"enum": [
"pass",
"fail",
"na"
]
},
"score": {
"nullable": true,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"evidence_turns": {
"maxItems": 20,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"rationale": {
"nullable": true,
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"verdict",
"score",
"evidence_turns",
"rationale"
],
"additionalProperties": false
}
}
},
"required": [
"score",
"rejudged",
"criteria"
],
"additionalProperties": false
},
"reason": {
"nullable": true,
"type": "string",
"pattern": "^[a-z][a-z0-9_.:-]{0,127}$"
}
},
"required": [
"assertion_id",
"type",
"verdict",
"measured",
"evidence",
"judge",
"reason"
],
"additionalProperties": false
}
},
"guard": {
"type": "object",
"properties": {
"compliance_blocks": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"rpc_unconfirmed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"atomic_half_said": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"compliance_blocks",
"rpc_unconfirmed",
"atomic_half_said"
],
"additionalProperties": false
},
"content_state": {
"type": "string",
"enum": [
"retained",
"expired"
]
}
},
"required": [
"case_id",
"trial",
"attempt",
"run_id",
"state",
"verdict",
"reason",
"assertions",
"guard",
"content_state"
],
"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.