Voiceflow bearer token
Environments
Test changes in isolated environments.
Paste in your agent
1. Set up Voiceflow by following https://www.voiceflow.com/agents/setup 2. Read https://www.voiceflow.com/docs/api-reference/resources/environment.md — the Voiceflow documentation page "Environments". Use it to help me with this part of Voiceflow and answer my questions. Refer to https://www.voiceflow.com/docs/llms.txt if you need related documentation.
See Authentication for credentials and permissions.
Current - 2026/07
/v1/stable/environmentReturns every environment in the project. An environment is one draft-and-published copy of the agent. The call takes no paging parameters, so one request yields the whole set.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment list --project-id <projectID>{
"environments": [
{
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
}
]
}Authentication
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonReturns every environment in the project, each with its name, alias, release history, whether it is the project's main environment, and the percentage of live traffic it currently takes.
/v1/stable/environment/mergeFolds the contents of one environment into another, so work done in a clone can be brought back to the environment it was cloned from.
curl --request PUT \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/merge?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sourceEnvironmentAlias": "<string>",
"targetEnvironmentAlias": "<string>",
"removeSourceEnvironment": false
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/merge?projectID=<projectID>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"sourceEnvironmentAlias": "<string>",
"targetEnvironmentAlias": "<string>",
"removeSourceEnvironment": false
}),
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/environment/merge?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"sourceEnvironmentAlias": "<string>",
"targetEnvironmentAlias": "<string>",
"removeSourceEnvironment": False
},
)
data = response.json()vf environment merge --project-id <projectID> <<'JSON'
{
"sourceEnvironmentAlias": "<string>",
"targetEnvironmentAlias": "<string>",
"removeSourceEnvironment": false
}
JSON{
"sourceEnvironment": {
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
},
"targetEnvironment": {
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
},
"targetRelease": {
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
}Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
Request body
The alias of the environment whose changes are merged.
The alias of the environment that receives the merged changes.
If true, the source environment is deleted after the merge.
Response
200 - application/jsonReturns the source and target environments as they stand after the merge, plus the resulting release on the target, with its name, description, and the ID of the backup that snapshots it.
Show child attributes
The ID of the backup that snapshots the environment for this release.
An optional description of what changed in this release.
Whether the release was created automatically by the system rather than published manually.
Current - 2026/07
/v1/stable/environment/update-traffic-splitChanges an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.
curl --request PUT \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/update-traffic-split?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"traffic": {}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/update-traffic-split?projectID=<projectID>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"traffic": {}
}),
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/environment/update-traffic-split?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"traffic": {}
},
)
data = response.json()vf environment update-traffic-split --project-id <projectID> <<'JSON'
{
"traffic": {}
}
JSON{
"message": "<string>"
}Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
Request body
Map of environmentAlias → traffic percentage (0-100). Values must sum to 100.
Response
200 - application/jsonConfirms the new split was saved. The body is a message only, so read the environments back to see the trafficPercentage now recorded against each one.
A human-readable message confirming the update.
Current - 2026/07
/v1/stable/environment/{environmentAlias}Returns a single environment by ID, with the fields that define it. An environment is one draft-and-published copy of the agent.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment get --environment-alias <environmentAlias> --project-id <projectID>{
"environment": {
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
}
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonReturns the one environment the alias resolves to, including its release history and the share of live traffic routed to it.
/v1/stable/environment/{environmentAlias}Changes an existing environment in place. The response carries only a confirmation message, so refetch the environment to read its new values.
curl --request PATCH \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>"
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"name": "<string>"
},
)
data = response.json()vf environment update --environment-alias <environmentAlias> --project-id <projectID> <<'JSON'
{
"name": "<string>"
}
JSON{
"message": "<string>"
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Request body
Response
200 - application/jsonConfirms the environment was updated. The body carries a message, not the environment, so fetch it again to see the change alongside its releases and traffic percentage.
A human-readable message confirming the update.
Current - 2026/07
/v1/stable/environment/{environmentAlias}Deletes a single environment by ID. An environment is one draft-and-published copy of the agent. The response carries only a confirmation message, so refetch the environments to see what is left.
curl --request DELETE \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>', {
method: 'DELETE',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.delete(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment delete --environment-alias <environmentAlias> --project-id <projectID>{
"message": "<string>"
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonConfirms the environment was deleted. Only a message comes back, so list the project's environments again to see which aliases remain.
A human-readable message confirming the deletion.
/v1/stable/environment/{environmentAlias}/diffCompare an environment's draft with its last publish.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/diff?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/diff?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/diff?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment diff --environment-alias <environmentAlias> --project-id <projectID>{
"diff": {
"created": 0,
"updated": 0,
"deleted": 0,
"resources": [
{
"type": "<string>",
"id": "<string>",
"name": "<string>",
"change": "<StableEnvironmentDiffChange>"
}
],
"truncated": true
}
}Authentication
Voiceflow bearer token
Path parameters
Query parameters
The ID of the project to operate on.
Response
200 - application/json/v1/stable/environment/{environmentAlias}/audit-wiringCheck how tools, functions and variables connect.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/audit-wiring?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment audit-wiring --environment-alias <environmentAlias> --project-id <projectID>{
"audit": {
"phase1VarSetters": {},
"phase2OrphanDefaults": [
{
"toolID": "<string>",
"function": "<string>",
"agent": "<string>",
"input": "<string>",
"defaultVar": "<string>",
"note": "<string>"
}
],
"phase3ShouldFulfillWithCanonicalSource": [
{
"toolID": "<string>",
"function": "<string>",
"agent": "<string>",
"input": "<string>",
"suggestedDefaultVar": "<string>",
"note": "<string>"
}
],
"phase4UncapturedOutputs": [
{
"function": "<string>",
"output": "<string>",
"toolCount": 0,
"note": "<string>"
}
],
"phase5MalformedWiring": [
{
"toolID": "<string>",
"function": "<string>",
"agent": "<string>",
"input": "<string>",
"issue": "<string>",
"current": "<string>",
"shouldBe": "<string>"
}
],
"phase6SuggestedCaptures": [
{
"function": "<string>",
"output": "<string>",
"suggestedVar": "<string>",
"currentCapturesTo": [
"<string>"
],
"note": "<string>"
}
],
"phase7SideEffectOnly": [
{
"function": "<string>",
"agents": [
"<string>"
],
"note": "<string>"
}
],
"phase8OrphanFunctions": [
{
"function": "<string>",
"inputCount": 0,
"outputCount": 0,
"note": "<string>"
}
],
"phase9ArgsSecretsReads": [
{
"function": "<string>",
"attachments": [
{
"agent": "<string>",
"toolID": "<string>"
}
],
"note": "<string>"
}
],
"phase10EmptyToolDescriptions": [
{
"toolID": "<string>",
"function": "<string>",
"agent": "<string>",
"note": "<string>"
}
]
}
}Authentication
Voiceflow bearer token
Path parameters
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonOne list per check. Each entry names the function, agent or tool it is about and says why.
Legacy - 2026/07
/v1/stable/environment/{environmentAlias}/exportSerialises the whole environment - its agent, playbooks, tools and knowledge base - into a single document you can archive or move to another project.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/export?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment export --environment-alias <environmentAlias> --project-id <projectID>{
"secrets": [
{
"id": "<string>",
"name": "<string>",
"visibility": "<SecretVisibility>",
"hasValue": true,
"assistantID": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0
}
],
"project": {
"_id": "<string>",
"nlu": "<string>",
"type": "<string>",
"name": "<string>",
"image": "<string>",
"teamID": "<string>",
"members": [
"<ProjectMember>"
],
"privacy": "<ProjectPrivacy>",
"platform": "<string>",
"_version": 0,
"linkType": "<string>",
"stickers": [
"<ProjectSticker>"
],
"creatorID": 0,
"updatedBy": 0,
"createdAt": "<string>",
"updatedAt": "<string>",
"prototype": "<ProjectPrototype>",
"apiPrivacy": "<ProjectPrivacy>",
"reportTags": {},
"nluSettings": "<ProjectNLUSettings>",
"environments": {},
"platformData": {},
"customThemes": [
"<ProjectCustomTheme>"
],
"aiAssistSettings": "<ProjectAIAssistSettings>",
"transcriptSettings": "<ProjectTranscriptSettings>",
"analyticsSettings": "<ProjectAnalyticsSettings>",
"objective": "<ProjectObjective>",
"devVersion": "<string>",
"liveVersion": "<string>",
"stagingVersion": "<string>",
"previewVersion": "<string>",
"knowledgeBase": "<VersionKnowledgeBase>"
},
"_version": "<string>",
"programs": {},
"assistant": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"version": 0,
"folderID": null,
"isDeleted": true,
"description": null,
"workspaceID": "<string>",
"activeEnvironmentID": "<string>"
},
"variableStates": [
{
"_id": "<string>",
"name": "<string>",
"projectID": "<string>",
"variables": {},
"startFrom": "<VariableStateStartFrom>"
}
],
"transcriptEvaluations": [
{
"name": "<string>",
"description": "<string>",
"enabled": true,
"prompt": "<string>",
"settings": "<TranscriptEvaluationSettings>",
"runScope": "<TranscriptEvaluationRunScope>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"systemTag": "<string>",
"id": "<string>",
"default": true
}
],
"version": {
"_id": "<string>",
"name": "<string>",
"model": "<VersionModel>",
"legacyID": "<string>",
"updatedAt": "<string>",
"updatedBy": 0,
"settings": "<VersionSettings>",
"_version": 0,
"creatorID": 0,
"projectID": "<string>",
"manualSave": true,
"publishedAt": "<string>",
"platformData": {
"slots": [
"<VersionSlot>"
],
"intents": [
"<VersionIntent>"
],
"settings": "<VersionPlatformSettings>",
"publishing": {}
},
"customBlocks": {},
"rootDiagramID": "<string>",
"canvasTemplates": [
"<VersionCanvasTemplate>"
],
"programResources": "<VersionProgramResources>",
"templateDiagramID": "<string>",
"defaultStepColors": {},
"autoSaveFromRestore": true,
"notes": {},
"topics": [
"<VersionFolderItem>"
],
"folders": {},
"domains": [
"<VersionDomain>"
],
"prototype": "<VersionPrototype>",
"components": [
"<VersionFolderItem>"
],
"variables": [
"<string>"
],
"knowledgeBase": "<VersionKnowledgeBase>",
"secondaryVersionID": 0,
"compiledSourceHash": "<string>"
},
"diagrams": {},
"intents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"entityOrder": [
"<string>"
],
"automaticReprompt": true,
"automaticRepromptSettings": "<AutomaticReprompt>"
}
],
"utterances": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<UtteranceText>",
"language": "<Language>",
"intentID": "<string>"
}
],
"requiredEntities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"intentID": "<string>",
"entityID": "<string>",
"repromptID": "<string>"
}
],
"responses": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"type": null,
"draft": null
}
],
"responseMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<Markup>",
"delay": 0,
"condition": "<AnyCondition>",
"discriminatorID": "<string>"
}
],
"responseDiscriminators": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"channel": "<Channel>",
"language": "<Language>",
"responseID": "<string>",
"variantOrder": [
"<string>"
]
}
],
"functions": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"code": "<string>",
"image": "<string>",
"pathOrder": [
"<string>"
],
"description": "<string>",
"settings": "<FunctionSettings>"
}
],
"functionPaths": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"label": "<string>",
"functionID": "<string>"
}
],
"functionVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"type": "<FunctionVariableKind>",
"functionID": "<string>",
"description": "<string>"
}
],
"flows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"diagramID": "<string>",
"description": "<string>"
}
],
"agents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"endTool": null,
"settings": "<AgentSettings>",
"cardTool": null,
"isOperator": false,
"buttonTool": null,
"description": "<string>",
"instructions": "<Markup>",
"skipTurnTool": null,
"carouselTool": null,
"pathToolOrder": [
"<string>"
],
"webSearchTool": "<AgentWebSearchTool>",
"callForwardTool": null,
"knowledgeBaseTool": "<AgentKnowledgeBaseTool>"
}
],
"agentAPITools": [],
"agentFlowTools": [],
"agentPathTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"agentID": "<string>",
"description": "<string>",
"variableOrder": [
"<string>"
],
"messages": null
}
],
"agentFunctionTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"functionID": "<string>",
"description": "<string>",
"inputVariables": {},
"captureResponse": {},
"toolSound": null,
"agentID": "<string>",
"messages": null,
"asyncExecution": false,
"captureInputVariables": {}
}
],
"agentIntegrationTools": [],
"agentFlowToolVariables": [],
"agentPathToolVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"kind": "<AgentToolVariableKind>",
"entityID": "<string>",
"variableID": "<string>",
"description": "<string>",
"agentPathToolID": "<string>"
}
],
"agentMcpIntegrationTools": [],
"events": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"flowID": null,
"goesTo": null,
"isSystem": true,
"requestName": "<string>",
"description": "<string>"
}
],
"entities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"classifier": "<string>",
"description": "<string>"
}
],
"entityVariants": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"value": "<string>",
"language": "<Language>",
"synonyms": [
"<string>"
],
"entityID": "<string>"
}
],
"folders": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"scope": "<FolderScope>",
"parentID": "<string>"
}
],
"prompts": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"draft": null,
"settings": "<PromptSettings>",
"description": "<string>",
"messageOrder": [
"<string>"
]
}
],
"promptMessages": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"type": "<PromptMessageType>",
"data": "<PromptMessageData>",
"pairID": "<string>",
"promptID": "<string>"
}
],
"apiTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"url": "<Markup>",
"body": "<APIToolBody>",
"image": "<string>",
"headers": [
"<APIToolKeyValue>"
],
"httpMethod": "<APIToolHTTPMethodType>",
"description": "<string>",
"queryParameters": [
"<APIToolKeyValue>"
],
"settings": "<APIToolSettings>"
}
],
"apiToolInputVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"apiToolID": "<string>",
"description": "<string>"
}
],
"simulations": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"settings": "<SimulationSettings>",
"turnOrder": [
"<string>"
]
}
],
"simulationTurns": [
"<UserSimulationTurn>"
],
"simulationTurnTests": [
"<ToolSimulationTurnTest>"
],
"variables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"isSystem": true,
"datatype": "<VariableDatatype>",
"description": "<string>",
"defaultValue": "<string>",
"resetAfter": "never"
}
],
"workflows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"status": "<WorkflowStatus>",
"name": "<string>",
"isStart": true,
"diagramID": "<string>",
"assigneeID": 0,
"description": "<string>"
}
],
"attachments": [
"<CardAttachment>"
],
"cardButtons": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"label": "<Markup>",
"cardID": "<string>"
}
],
"integrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<IntegrationToolName>",
"description": "<string>",
"toolProvider": "<IntegrationToolProvider>"
}
],
"mcpIntegrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"mcpServerToolID": "<string>"
}
],
"mcpServers": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"image": null,
"description": null,
"specification": "2025-03-26",
"url": null,
"headers": null,
"authType": "custom",
"oauthMetadata": null
}
],
"mcpServerTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<string>",
"description": "<string>",
"inputSchema": "<JsonSchema>",
"mcpServerID": "<string>"
}
],
"personas": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"items": [
"<PersonaItem>"
]
}
],
"kbDocumentVersions": [
{
"id": "<string>",
"documentID": "<string>",
"versionID": "<string>",
"folderID": "<string>"
}
],
"kbSettings": {
"id": "<string>",
"versionID": "<string>",
"summarization": "<KnowledgeBaseSummarization>",
"chunkStrategy": "<KnowledgeBaseChunkStrategy>",
"search": "<KnowledgeBaseSearch>",
"embeddingModel": "<KnowledgeBaseEmbeddingModel>"
},
"kbDocumentMetadataM2M": [
{
"id": "<string>",
"metadataFieldID": "<string>",
"documentID": "<string>",
"versionID": "<string>"
}
]
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonReturns the whole environment as one JSON document: its project and version records, every workflow, agent, tool, function, variable and knowledge base document version, and its secrets. Most sections appear only when the environment has something of that kind.
Show child attributes
@deprecated use project.environments instead with environments projects
Show child attributes
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of binary evaluations.
booleanThis prompt describes which transcripts should evaluate as 'true'.
This prompt describes which transcripts should evaluate as 'false'.
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of rating evaluations.
numberThe lowest rating that can be applied.
This prompt describes which transcripts should receive lower ratings.
The highest rating that can be applied.
This prompt describes which transcripts should receive higher ratings.
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of text evaluations.
stringShow child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of options evaluations.
optionThe options that should be evaluated for.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
prompt, memory, memory_promptShow child attributes
recursive_text_splitterShow child attributes
Show child attributes
Current - 2026/09
/v2/stable/environment/{environmentAlias}/exportSerializes the whole environment - its agent, playbooks, tools and knowledge base - into a single document you can archive or move to another project. Rich text comes back as plain strings with {name} references.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v2/stable/environment/<environmentAlias>/export?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/environment/<environmentAlias>/export?projectID=<projectID>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v2/stable/environment/<environmentAlias>/export?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment export --environment-alias <environmentAlias> --project-id <projectID>{
"secrets": [
{
"id": "<string>",
"name": "<string>",
"visibility": "<SecretVisibility>",
"hasValue": true,
"assistantID": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0
}
],
"project": {
"_id": "<string>",
"nlu": "<string>",
"type": "<string>",
"name": "<string>",
"image": "<string>",
"teamID": "<string>",
"members": [
"<ProjectMember>"
],
"privacy": "<ProjectPrivacy>",
"platform": "<string>",
"_version": 0,
"linkType": "<string>",
"stickers": [
"<ProjectSticker>"
],
"creatorID": 0,
"updatedBy": 0,
"createdAt": "<string>",
"updatedAt": "<string>",
"prototype": "<ProjectPrototype>",
"apiPrivacy": "<ProjectPrivacy>",
"reportTags": {},
"nluSettings": "<ProjectNLUSettings>",
"environments": {},
"platformData": {},
"customThemes": [
"<ProjectCustomTheme>"
],
"aiAssistSettings": "<ProjectAIAssistSettings>",
"transcriptSettings": "<ProjectTranscriptSettings>",
"analyticsSettings": "<ProjectAnalyticsSettings>",
"objective": "<ProjectObjective>",
"devVersion": "<string>",
"liveVersion": "<string>",
"stagingVersion": "<string>",
"previewVersion": "<string>",
"knowledgeBase": "<VersionKnowledgeBase>"
},
"_version": "<string>",
"programs": {},
"assistant": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"version": 0,
"folderID": null,
"isDeleted": true,
"description": null,
"workspaceID": "<string>",
"activeEnvironmentID": "<string>"
},
"variableStates": [
{
"_id": "<string>",
"name": "<string>",
"projectID": "<string>",
"variables": {},
"startFrom": "<VariableStateStartFrom>"
}
],
"transcriptEvaluations": [
{
"name": "<string>",
"description": "<string>",
"enabled": true,
"prompt": "<string>",
"settings": "<TranscriptEvaluationSettings>",
"runScope": "<TranscriptEvaluationRunScope>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"systemTag": "<string>",
"id": "<string>",
"default": true
}
],
"version": {
"_id": "<string>",
"name": "<string>",
"model": "<VersionModel>",
"legacyID": "<string>",
"updatedAt": "<string>",
"updatedBy": 0,
"settings": "<StableExportVersionSettings>",
"_version": 0,
"creatorID": 0,
"projectID": "<string>",
"manualSave": true,
"publishedAt": "<string>",
"platformData": {
"slots": [
"<VersionSlot>"
],
"intents": [
"<VersionIntent>"
],
"settings": "<VersionPlatformSettings>",
"publishing": {}
},
"customBlocks": {},
"rootDiagramID": "<string>",
"canvasTemplates": [
"<VersionCanvasTemplate>"
],
"programResources": "<StableExportVersionProgramResources>",
"templateDiagramID": "<string>",
"defaultStepColors": {},
"autoSaveFromRestore": true,
"notes": {},
"topics": [
"<VersionFolderItem>"
],
"folders": {},
"domains": [
"<VersionDomain>"
],
"prototype": "<VersionPrototype>",
"components": [
"<VersionFolderItem>"
],
"variables": [
"<string>"
],
"knowledgeBase": "<VersionKnowledgeBase>",
"secondaryVersionID": 0,
"compiledSourceHash": "<string>"
},
"diagrams": {},
"intents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"entityOrder": [
"<string>"
],
"automaticReprompt": true,
"automaticRepromptSettings": "<AutomaticReprompt>"
}
],
"utterances": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"text": "<ExportTextString>",
"language": "<Language>",
"intentID": "<string>"
}
],
"requiredEntities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"intentID": "<string>",
"entityID": "<string>",
"repromptID": "<string>"
}
],
"functions": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"code": "<string>",
"image": "<string>",
"pathOrder": [
"<string>"
],
"description": "<string>",
"settings": "<FunctionSettings>"
}
],
"functionPaths": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"label": "<string>",
"functionID": "<string>"
}
],
"functionVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"type": "<FunctionVariableKind>",
"functionID": "<string>",
"description": "<string>"
}
],
"flows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"diagramID": "<string>",
"description": "<string>"
}
],
"agents": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"endTool": null,
"settings": "<AgentSettings>",
"cardTool": null,
"isOperator": false,
"buttonTool": null,
"description": "<string>",
"instructions": "<ExportTextString>",
"skipTurnTool": null,
"carouselTool": null,
"pathToolOrder": [
"<string>"
],
"webSearchTool": "<StableExportAgentWebSearchTool>",
"callForwardTool": null,
"knowledgeBaseTool": "<StableExportAgentKnowledgeBaseTool>"
}
],
"agentAPITools": [],
"agentFlowTools": [],
"agentPathTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"agentID": "<string>",
"description": "<string>",
"variableOrder": [
"<string>"
],
"messages": null
}
],
"agentFunctionTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"functionID": "<string>",
"description": "<string>",
"inputVariables": {},
"captureResponse": {},
"toolSound": null,
"agentID": "<string>",
"messages": null,
"asyncExecution": false,
"captureInputVariables": {}
}
],
"agentIntegrationTools": [],
"agentFlowToolVariables": [],
"agentPathToolVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"kind": "<AgentToolVariableKind>",
"entityID": "<string>",
"variableID": "<string>",
"description": "<string>",
"agentPathToolID": "<string>"
}
],
"agentMcpIntegrationTools": [],
"events": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"name": "<string>",
"flowID": null,
"goesTo": null,
"isSystem": true,
"requestName": "<string>",
"description": "<string>"
}
],
"entities": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"classifier": "<string>",
"description": "<string>"
}
],
"entityVariants": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"value": "<string>",
"language": "<Language>",
"synonyms": [
"<string>"
],
"entityID": "<string>"
}
],
"folders": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"scope": "<FolderScope>",
"parentID": "<string>"
}
],
"apiTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"url": "<ExportTextString>",
"body": "<StableExportAPIToolBody>",
"image": "<string>",
"headers": [
"<StableExportAPIToolKeyValue>"
],
"httpMethod": "<APIToolHTTPMethodType>",
"description": "<string>",
"queryParameters": [
"<StableExportAPIToolKeyValue>"
],
"settings": "<APIToolSettings>"
}
],
"apiToolInputVariables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"apiToolID": "<string>",
"description": "<string>"
}
],
"simulations": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"settings": "<SimulationSettings>",
"turnOrder": [
"<string>"
]
}
],
"simulationTurns": [
"<UserSimulationTurn>"
],
"simulationTurnTests": [
"<ToolSimulationTurnTest>"
],
"variables": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"color": "<string>",
"isArray": true,
"isSystem": true,
"datatype": "<VariableDatatype>",
"description": "<string>",
"defaultValue": "<string>",
"resetAfter": "never"
}
],
"workflows": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"folderID": "<string>",
"createdByID": 0,
"status": "<WorkflowStatus>",
"name": "<string>",
"isStart": true,
"diagramID": "<string>",
"assigneeID": 0,
"description": "<string>"
}
],
"attachments": [
"<StableExportCardAttachment>"
],
"cardButtons": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"label": "<ExportTextString>",
"cardID": "<string>"
}
],
"integrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<IntegrationToolName>",
"description": "<string>",
"toolProvider": "<IntegrationToolProvider>"
}
],
"mcpIntegrationTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"description": "<string>",
"mcpServerToolID": "<string>"
}
],
"mcpServers": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"image": null,
"description": null,
"specification": "2025-03-26",
"url": null,
"headers": null,
"authType": "custom",
"oauthMetadata": null
}
],
"mcpServerTools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"folderID": "<string>",
"createdByID": 0,
"toolName": "<string>",
"description": "<string>",
"inputSchema": "<JsonSchema>",
"mcpServerID": "<string>"
}
],
"personas": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"updatedByID": 0,
"assistantID": "<string>",
"environmentID": "<string>",
"name": "<string>",
"items": [
"<PersonaItem>"
]
}
],
"kbDocumentVersions": [
{
"id": "<string>",
"documentID": "<string>",
"versionID": "<string>",
"folderID": "<string>"
}
],
"kbSettings": {
"id": "<string>",
"versionID": "<string>",
"summarization": "<KnowledgeBaseSummarization>",
"chunkStrategy": "<KnowledgeBaseChunkStrategy>",
"search": "<KnowledgeBaseSearch>",
"embeddingModel": "<KnowledgeBaseEmbeddingModel>"
},
"kbDocumentMetadataM2M": [
{
"id": "<string>",
"metadataFieldID": "<string>",
"documentID": "<string>",
"versionID": "<string>"
}
],
"messages": [
{
"id": "<string>",
"variants": [
"<StableMessageVariant>"
],
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"createdByID": 0,
"updatedByID": 0
}
],
"prompts": [
{
"id": "<string>",
"name": "<string>",
"system": "<VariableReferenceString>",
"settings": "<PromptSettings>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"createdByID": 0,
"updatedByID": 0
}
]
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonReturns the whole environment as one JSON document: its project and version records, every workflow, agent, tool, function, variable and knowledge base document version, and its secrets. Rich text is a string, and most sections appear only when the environment has something of that kind.
Show child attributes
@deprecated use project.environments instead with environments projects
Show child attributes
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of binary evaluations.
booleanThis prompt describes which transcripts should evaluate as 'true'.
This prompt describes which transcripts should evaluate as 'false'.
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of rating evaluations.
numberThe lowest rating that can be applied.
This prompt describes which transcripts should receive lower ratings.
The highest rating that can be applied.
This prompt describes which transcripts should receive higher ratings.
Show child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of text evaluations.
stringShow child attributes
Name of the evaluation.
Description of the evaluation.
When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
The model settings passed when invoking this evaluation.
Show child attributes
voice, eagernessShow child attributes
The service tier to request from models that support it. priority is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level priorityProcessing setting applies.
Show child attributes
Whether each result includes a written explanation. Text evaluations always do.
Which transcripts this evaluation runs on automatically, by the publish state of their version.
The type of options evaluations.
optionThe options that should be evaluated for.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
prompt, memory, memory_promptShow child attributes
recursive_text_splitterShow child attributes
Show child attributes
/v1/stable/environment/{environmentAlias}/searchFinds a word, phrase, ID or regular expression across the text of the whole environment and returns where each match is. Results are paged with limit and offset: pass the previous response's nextOffset as offset to get the next page.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/search?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"pattern": "<string>",
"regex": true,
"ignoreCase": true,
"wholeWord": true,
"resourceTypes": [
"agent"
],
"limit": 0,
"offset": 0
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/search?projectID=<projectID>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"pattern": "<string>",
"regex": true,
"ignoreCase": true,
"wholeWord": true,
"resourceTypes": [
"agent"
],
"limit": 0,
"offset": 0
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/search?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"pattern": "<string>",
"regex": True,
"ignoreCase": True,
"wholeWord": True,
"resourceTypes": [
"agent"
],
"limit": 0,
"offset": 0
},
)
data = response.json()vf environment search-text --environment-alias <environmentAlias> --project-id <projectID> <<'JSON'
{
"pattern": "<string>",
"regex": true,
"ignoreCase": true,
"wholeWord": true,
"resourceTypes": [
"agent"
],
"limit": 0,
"offset": 0
}
JSON{
"hits": [
{
"resourceType": "agent",
"resourceID": "<string>",
"resourceName": "<string>",
"ownerID": "<string>",
"blockID": "<string>",
"stepID": "<string>",
"stepKind": "<string>",
"field": "<string>",
"line": 0,
"count": 0,
"snippet": "<string>",
"usedBy": [
"<StableSearchTextHolder>"
]
}
],
"totalMatches": 0,
"byResourceType": {},
"hasMore": true,
"nextOffset": 0,
"incomplete": true,
"notSearched": [
"<string>"
]
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to search (e.g. main).
Query parameters
The ID of the project to operate on.
Request body
The word, phrase or ID to find. With regex, a JavaScript regular expression.
Read pattern as a regular expression. Default false: literal text.
Ignore case. Default true.
Match only where no letter, digit or underscore touches the match on either side. Default false.
Search only these kinds of resource. Default: all of them.
Hits per page. Default 50.
Hits to skip: nextOffset from the previous page.
Response
200 - application/jsonReturns one page of matches with the resource, field and line of each, the total match count, a count per resource type, whether more pages exist, and the kinds of text that are never searched.
Matches in everything searched, not only this page.
Matching lines per resource type, in everything searched.
Present when the search did not read everything: it stopped at its time limit, or a regular expression read only the first 1,000 characters of a longer line. The counts cover only what it read.
trueWhat this search never reads.
/v1/stable/environment/{environmentAlias}/compileRebuilds the environment’s runtime form from its current definition, which is what a conversation actually executes against.
curl --request PUT \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/compile?projectID=<projectID>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/compile?projectID=<projectID>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/compile?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf environment compile --environment-alias <environmentAlias> --project-id <projectID>{
"message": "<string>",
"durationMs": 0
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Response
200 - application/jsonReturns a confirmation message and durationMs, how long the compilation took in milliseconds. The environment itself is not part of the response.
A human-readable message confirming the update.
How long the compilation took, in milliseconds.
Current - 2026/07
/v1/stable/environment/{environmentAlias}/cloneCopies an environment into a new one under an alias you choose, giving somewhere to change the agent without touching the environment being cloned.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/clone?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"alias": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/clone?projectID=<projectID>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"alias": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/clone?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"name": "<string>",
"alias": "<string>"
},
)
data = response.json()vf environment clone --environment-alias <environmentAlias> --project-id <projectID> <<'JSON'
{
"name": "<string>",
"alias": "<string>"
}
JSON{
"environment": {
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
}
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Request body
The display name of the new environment.
Short URL-safe identifier; cannot be 'main' (reserved).
Response
201 - application/jsonReturns the new environment, including the alias that subsequent calls pass as environmentAlias to target it.
Current - 2026/07
/v1/stable/environment/{environmentAlias}/publishPromotes the environment’s draft to its published version, which is the copy real traffic reaches. The request names the release so it can be told apart in the history.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/publish?projectID=<projectID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": null
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/publish?projectID=<projectID>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"description": null
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/environment/<environmentAlias>/publish?projectID=<projectID>',
headers={'Authorization': 'Bearer <token>'},
json={
"name": "<string>",
"description": None
},
)
data = response.json()vf environment publish --environment-alias <environmentAlias> --project-id <projectID> <<'JSON'
{
"name": "<string>",
"description": null
}
JSON{
"environment": {
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
],
"createdAt": "2026-09-10T00:00:00.000Z",
"trafficPercentage": 0
},
"release": {
"name": "<string>",
"backupID": 0,
"createdAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"autogenerated": true
}
}Authentication
Voiceflow bearer token
Path parameters
The alias of the environment to operate on (e.g. main).
Query parameters
The ID of the project to operate on.
Request body
The name of the release created by publishing.
An optional description of what changed in this release.
Response
201 - application/jsonReturns the environment together with the release the publish produced, giving the release name, its description, when it was created, and the ID of the backup that snapshots the environment at that release.
Show child attributes
The ID of the backup that snapshots the environment for this release.
An optional description of what changed in this release.
Whether the release was created automatically by the system rather than published manually.
Legacy - 2026/05
/v1alpha1/project/{projectID}/environmentsList all environments for the target assistant.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environments' \
--header 'Authorization: <api-key>'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environments', {
method: 'GET',
headers: {
Authorization: '<api-key>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environments',
headers={'Authorization': '<api-key>'},
)
data = response.json(){
"data": [
{
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
"<Legacy13_ProjectEnvironmentRelease>"
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 0,
"clonedFromMainAt": "<string>",
"trafficPercentage": 0,
"nextReleaseNumber": 0,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
}
]
}Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
Response
200 - application/jsonThe environments for the target assistant.
Legacy - 2026/05
/v1alpha1/project/{projectID}/environment/{projectEnvironmentIDorAlias}Get a specific environment by ID or alias for the target assistant.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>' \
--header 'Authorization: <api-key>'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>', {
method: 'GET',
headers: {
Authorization: '<api-key>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>',
headers={'Authorization': '<api-key>'},
)
data = response.json(){
"data": {
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 0
}
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 0,
"clonedFromMainAt": "<string>",
"trafficPercentage": 0,
"nextReleaseNumber": 0,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
}
}Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
ID or alias of the environment to fetch.
Response
200 - application/jsonThe requested environment.
Legacy - 2026/05
/v1alpha1/project/{projectID}/environmentCreate a new environment by cloning another environment. When alias is omitted, one is generated from name. When cloneFromEnvironmentID is omitted, the assistant's main environment is used.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"alias": "<string>",
"cloneFromEnvironmentID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment', {
method: 'POST',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"alias": "<string>",
"cloneFromEnvironmentID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment',
headers={'Authorization': '<api-key>'},
json={
"name": "<string>",
"alias": "<string>",
"cloneFromEnvironmentID": "<string>"
},
)
data = response.json(){
"data": {
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
{
"name": "<string>",
"backupID": 0,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 0
}
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 0,
"clonedFromMainAt": "<string>",
"trafficPercentage": 0,
"nextReleaseNumber": 0,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
}
}Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
Request body
Response
201 - application/jsonThe newly created environment.
Legacy - 2026/05
/v1alpha1/project/{projectID}/environment/{projectEnvironmentIDorAlias}/publishPublish the target environment's draft as its new published version. The environment can be targeted by ID or alias.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>/publish' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>/publish', {
method: 'POST',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "<string>",
"description": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentIDorAlias>/publish',
headers={'Authorization': '<api-key>'},
json={
"name": "<string>",
"description": "<string>"
},
)
data = response.json(){
"data": {
"projectEnvironment": {
"id": "<string>",
"name": "<string>",
"alias": "<string>",
"isMain": true,
"releases": [
"<Legacy16_ProjectEnvironmentRelease>"
],
"createdAt": "<string>",
"draftVersionID": "<string>",
"createdByUserID": 0,
"clonedFromMainAt": "<string>",
"trafficPercentage": 0,
"nextReleaseNumber": 0,
"publishedVersionID": "<string>",
"draftVersionIDsHistory": [
"<string>"
]
},
"projectEnvironmentRelease": {
"name": "<string>",
"backupID": 0,
"createdAt": "<string>",
"versionID": "<string>",
"description": "<string>",
"autogenerated": true,
"createdByUserID": 0
}
}
}Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
ID or alias of the environment to publish.
Request body
Response
201 - application/jsonThe updated environment and created release.
Show child attributes
Legacy - 2026/05
/v1alpha1/project/{projectID}/environment/trafficUpdate the traffic split configuration for all environments on the target assistant. The request can be keyed by environment ID or alias. Percentages must sum to 100.
curl --request PATCH \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/traffic' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{}'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/traffic', {
method: 'PATCH',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/traffic',
headers={'Authorization': '<api-key>'},
json={},
)
data = response.json(){
"data": {}
}Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
Request body
Response
200 - application/jsonThe updated traffic split configuration, keyed by environment ID.
Legacy - 2026/05
/v1alpha1/project/{projectID}/environment/{projectEnvironmentID}curl --request DELETE \
--url 'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentID>' \
--header 'Authorization: <api-key>'const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentID>', {
method: 'DELETE',
headers: {
Authorization: '<api-key>',
},
});
// This operation returns no response body.
console.log(response.status);import requests
response = requests.delete(
'https://realtime-api.voiceflow.com/v1alpha1/project/<projectID>/environment/<projectEnvironmentID>',
headers={'Authorization': '<api-key>'},
)
response.raise_for_status()
# This operation returns no response body.Authentication
Voiceflow API key
Path parameters
ID of the project that owns the environments.
Response
204Schemas
AIMessageSimple
{"type":"object"}
| Property | Definition |
|---|---|
cachePoint | {"type":"object","properties":{"type":{"type":"string","enum":["default"],"x-enumNames":["DEFAULT"]}},"required":["type"]} |
role · required | {"$ref":"AIMessageSimpleRole"} |
content · required | {"anyOf":[{"type":"string"},{"type":"array","items":{"$ref":"ContentPart"}}]} |
attachments | {"type":"array","items":{"$ref":"FileAttachmentMetadata"}} |
AIMessageSimpleRole
{"type":"string","enum":["user","assistant","system"],"x-enumNames":["USER","ASSISTANT","SYSTEM"]}
AIModel
{"type":"string","enum":["gpt-3.5-turbo-1106","gpt-3.5-turbo","gpt-4","gpt-4o","gpt-4o-mini","gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","gpt-o3-mini","o3-2025-04-16","o4-mini-2025-04-16","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5.2","gpt-5.4","gpt-5.4-mini","gpt-5.5","gpt-5.6-sol","gpt-5.6-terra","gpt-5.6-luna","gpt-6-sol","gpt-6-luna","gpt-6.1-sol","gpt-realtime","gpt-live-1","claude-4-opus","claude-4-sonnet","claude-4.5-sonnet","claude-4.6-sonnet","claude-4.5-haiku","claude-4.5-opus","claude-4.7-opus","bedrock-claude-4-sonnet","bedrock-claude-4.5-sonnet","bedrock-claude-4.6-sonnet","bedrock-claude-5-sonnet","bedrock-claude-5.5-sonnet","bedrock-claude-4.5-haiku","bedrock-claude-5.5-haiku","bedrock-claude-4.5-opus","bedrock-claude-4.7-opus","bedrock-claude-4.8-opus","voiceflow-core-4.0","voiceflow-core-4.1","voiceflow-core-4.2","voiceflow-flash-4.2","gemini-2.5-pro","gemini-2.5-flash","gemini-live-2.5-flash","gemini-3-flash","gemini-3.5-flash","gemini-3.1-pro","gpt-oss-20b","gpt-oss-120b","llama-guard-4","llama-3.1-instant","llama-3.3-versatile","qwen3.6-27b","grok-4.6","voiceflow-flash-4.1","kimi-k3","gemini-flash-2","gpt-4-turbo","claude-3.5-haiku","claude-3-opus","claude-3.7-sonnet","claude-v2","llama-3.2-1b-preview","gemini-pro-1.5","claude-3-haiku","claude-3-sonnet","text-davinci-003","claude-v1","claude-instant-v1","deep-seek-r1-distill-llama-70B","claude-3.5-sonnet"],"x-enumNames":["GPT_3_5_TURBO_1106","GPT_3_5_TURBO","GPT_4","GPT_4_O","GPT_4_O_MINI","GPT_4_1","GPT_4_1_MINI","GPT_4_1_NANO","GPT_O_3_MINI","GPT_O_3","GPT_O_4_MINI","GPT_5","GPT_5_MINI","GPT_5_NANO","GPT_5_2","GPT_5_4","GPT_5_4_MINI","GPT_5_5","GPT_5_6_SOL","GPT_5_6_TERRA","GPT_5_6_LUNA","GPT_6_SOL","GPT_6_LUNA","GPT_6_1_SOL","GPT_REALTIME","GPT_LIVE_1","CLAUDE_4_OPUS","CLAUDE_4_SONNET","CLAUDE_4_5_SONNET","CLAUDE_4_6_SONNET","CLAUDE_4_5_HAIKU","CLAUDE_4_5_OPUS","CLAUDE_4_7_OPUS","BEDROCK_CLAUDE_4_SONNET","BEDROCK_CLAUDE_4_5_SONNET","BEDROCK_CLAUDE_4_6_SONNET","BEDROCK_CLAUDE_5_SONNET","BEDROCK_CLAUDE_5_5_SONNET","BEDROCK_CLAUDE_4_5_HAIKU","BEDROCK_CLAUDE_5_5_HAIKU","BEDROCK_CLAUDE_4_5_OPUS","BEDROCK_CLAUDE_4_7_OPUS","BEDROCK_CLAUDE_4_8_OPUS","VOICEFLOW_CORE_4_0","VOICEFLOW_CORE_4_1","VOICEFLOW_CORE_4_2","VOICEFLOW_FLASH_4_2","GEMINI_2_5_PRO","GEMINI_2_5_FLASH","GEMINI_LIVE_2_5_FLASH","GEMINI_3_FLASH","GEMINI_3_5_FLASH","GEMINI_3_1_PRO","GPT_OSS_20_B","GPT_OSS_120_B","LLAMA_GUARD_4","LLAMA_3_1_INSTANT","LLAMA_3_3_VERSATILE","QWEN_3_6_27_B","GROK_4_6","VOICEFLOW_FLASH_4_1","KIMI_K_3","GEMINI_FLASH_2","GPT_4_TURBO","CLAUDE_3_5_HAIKU","CLAUDE_3_OPUS","CLAUDE_3_7_SONNET","CLAUDE_V_2","LLAMA_3_2_1_B_PREVIEW","GEMINI_PRO_1_5","CLAUDE_3_HAIKU","CLAUDE_3_SONNET","DA_VINCI_003","CLAUDE_V_1","CLAUDE_INSTANT_V_1","DEEP_SEEK_R_1_DISTILL_LLAMA_70_B","CLAUDE_3_5_SONNET"]}
AIParams
{"type":"object"}
| Property | Definition |
|---|---|
stop | {"type":"array","items":{"type":"string"}} |
model | {"allOf":[{"$ref":"AIModel"}]} |
system | {"type":"string"} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
responseFormat | {"type":"string"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
serviceTier | The service tier to request from models that support it. {"nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]} |
realtime | {"type":"object","properties":{"voice":{"type":"string"},"eagerness":{"type":"string"}}} |
webSearch | {"type":"object","properties":{"allowedDomains":{"nullable":true,"type":"array","items":{"type":"string"}}}} |
AIParamsServiceTier
{"type":"string","enum":["default","flex","priority"],"x-enumNames":["DEFAULT","FLEX","PRIORITY"]}
AIPromptWrapper
{"type":"object"}
| Property | Definition |
|---|---|
content · required | {"type":"string"} |
AIProvider
{"type":"string","enum":["groq","azure","google","open-ai","anthropic","bedrock","voiceflow","xai","openrouter"],"x-enumNames":["GROQ","AZURE","GOOGLE","OPEN_AI","ANTHROPIC","BEDROCK","VOICEFLOW","XAI","OPENROUTER"]}
AIReasoningEffort
{"type":"string","enum":["off","adaptive","minimal","low","medium","high"],"x-enumNames":["OFF","ADAPTIVE","MINIMAL","LOW","MEDIUM","HIGH"]}
APINodeActionType
{"type":"string","enum":["Make a GET Request","Make a PUT Request","Make a POST Request","Make a PATCH Request","Make a DELETE Request"],"x-enumNames":["GET","PUT","POST","PATCH","DELETE"]}
APINodeBodyType
{"type":"string","enum":["formData","rawInput","urlEncoded"],"x-enumNames":["FORM_DATA","RAW_INPUT","URL_ENCODED"]}
APINodeMethodType
{"type":"string","enum":["GET","PUT","POST","PATCH","DELETE"],"x-enumNames":["GET","PUT","POST","PATCH","DELETE"]}
APITool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
url · required | {"nullable":true,"allOf":[{"$ref":"Markup"}]} |
body · required | {"nullable":true,"allOf":[{"$ref":"APIToolBody"}]} |
image · required | {"nullable":true,"type":"string"} |
headers · required | {"type":"array","items":{"$ref":"APIToolKeyValue"}} |
httpMethod · required | {"$ref":"APIToolHTTPMethodType"} |
description · required | {"nullable":true,"type":"string"} |
queryParameters · required | {"type":"array","items":{"$ref":"APIToolKeyValue"}} |
settings | {"nullable":true,"allOf":[{"$ref":"APIToolSettings"}]} |
APIToolBody
{"oneOf":[{"$ref":"APIToolRawBody"},{"$ref":"APIToolFormDataBody"},{"$ref":"APIToolURLEncodedBody"}]}
APIToolContentType
{"type":"string","enum":["text","json","xml"],"x-enumNames":["TEXT","JSON","XML"]}
APIToolFormDataBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["form-data"],"x-enumNames":["FORM_DATA"]} |
formData · required | {"type":"array","items":{"$ref":"APIToolKeyValue"}} |
APIToolHTTPMethodType
{"type":"string","enum":["get","put","post","patch","delete"],"x-enumNames":["GET","PUT","POST","PATCH","DELETE"]}
APIToolInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
apiToolID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
APIToolKeyValue / McpServerHeaderEntry
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
key · required | {"nullable":true,"type":"string"} |
value · required | {"nullable":true,"allOf":[{"$ref":"Markup"}]} |
APIToolRawBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["raw-input"],"x-enumNames":["RAW_INPUT"]} |
contentType | {"allOf":[{"$ref":"APIToolContentType"}]} |
content · required | {"$ref":"CodeText"} |
APIToolSettings / FunctionSettings
{"type":"object"}
| Property | Definition |
|---|---|
timeoutMs | {"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":600000} |
APIToolURLEncodedBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["url-encoded"],"x-enumNames":["URL_ENCODED"]} |
params · required | {"type":"array","items":{"$ref":"APIToolKeyValue"}} |
Agent
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
endTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentEndTool"}]} |
settings · required | {"$ref":"AgentSettings"} |
cardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentCardTool"}]} |
isOperator | {"default":false,"type":"boolean"} |
buttonTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentButtonTool"}]} |
description · required | {"nullable":true,"type":"string"} |
instructions · required | {"nullable":true,"allOf":[{"$ref":"Markup"}]} |
skipTurnTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentSkipTurnTool"}]} |
carouselTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentCardTool"}]} |
pathToolOrder · required | {"type":"array","items":{"type":"string"}} |
webSearchTool · required | {"nullable":true,"allOf":[{"$ref":"AgentWebSearchTool"}]} |
callForwardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentCallForwardTool"}]} |
knowledgeBaseTool · required | {"nullable":true,"allOf":[{"$ref":"AgentKnowledgeBaseTool"}]} |
AgentAPITool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
apiToolID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPIInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"}} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
asyncExecution | {"default":false,"type":"boolean"} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
AgentButtonTool / AgentCardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
description · required | {"type":"string"} |
AgentCallForwardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
address · required | {"$ref":"Markup"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
extension | {"allOf":[{"$ref":"Markup"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
addressType · required | {"$ref":"CallForwardAddressType"} |
callerIDPassthrough | {"type":"boolean"} |
AgentEndTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
AgentFlowTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
flowID · required | {"type":"string"} |
agentID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
AgentFlowToolVariable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
kind · required | {"$ref":"AgentToolVariableKind"} |
entityID · required | {"nullable":true,"type":"string"} |
variableID · required | {"nullable":true,"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
agentFlowToolID · required | {"type":"string"} |
AgentFunctionTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
functionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"}} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
asyncExecution | {"default":false,"type":"boolean"} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
AgentIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationStoredInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"}} |
integrationToolID · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
extendedInputVariables | {"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolExtendedInputVariable"}} |
extendedInputSchema | {"nullable":true,"type":"object","additionalProperties":{}} |
AgentKnowledgeBaseMetadataKeyFilter
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]} |
key · required | {"type":"string"} |
AgentKnowledgeBaseTool
{"type":"object"}
| Property | Definition |
|---|---|
query | {"nullable":true,"allOf":[{"$ref":"Markup"}]} |
enabled · required | {"type":"boolean"} |
filters | {"type":"array","items":{"$ref":"AgentKnowledgeBaseMetadataKeyFilter"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
chunkLimit | {"nullable":true,"type":"number"} |
description · required | {"type":"string"} |
queryMode | {"allOf":[{"$ref":"AgentKnowledgeBaseToolQueryMode"}]} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
AgentKnowledgeBaseToolQueryMode
{"type":"string","enum":["custom","rewriting"],"x-enumNames":["CUSTOM","REWRITING"]}
AgentMcpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"}} |
mcpIntegrationToolID · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
captureInputVariables · required | {"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
AgentPathTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
agentID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
variableOrder · required | {"type":"array","items":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
AgentPathToolVariable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
kind · required | {"$ref":"AgentToolVariableKind"} |
entityID · required | {"nullable":true,"type":"string"} |
variableID · required | {"nullable":true,"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
agentPathToolID · required | {"type":"string"} |
AgentSettings
{"type":"object"}
| Property | Definition |
|---|---|
model | {"allOf":[{"$ref":"AIModel"}]} |
realtime | {"type":"object","properties":{"voice":{"type":"string"},"eagerness":{"type":"string"}}} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
serviceTier | The service tier to request from models that support it. {"nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]} |
AgentSimulationTurn
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["agent"],"x-enumNames":["AGENT"]} |
payload · required | {"$ref":"AgentSimulationTurnPayload"} |
testOrder · required | {"type":"array","items":{"type":"string"}} |
simulationID · required | {"type":"string"} |
AgentSimulationTurnPayload
{"type":"object"}
| Property | Definition |
|---|---|
testOrderMatters · required | {"type":"boolean"} |
AgentSkipTurnTool / CompiledAgentSkipTurnTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
description · required | {"type":"string"} |
AgentToolCaptureInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
variableOrEntityID · required | {"nullable":true,"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
AgentToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
generative | {"type":"object","properties":{"delay":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"execution":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"ToolMessageGenerative"}]}}} |
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
AgentToolVariableKind
{"type":"string","enum":["entity","variable"],"x-enumNames":["ENTITY","VARIABLE"]}
AgentWebSearchTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description | {"type":"string"} |
allowedDomains | {"nullable":true,"type":"array","items":{"type":"string"}} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
AmazonVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["amazon"],"x-enumNames":["AMAZON"]} |
voice · required | {"type":"string"} |
AnyAttachment
{"anyOf":[{"$ref":"CardAttachment"},{"$ref":"MediaAttachment"}]}
AnyCompiledCondition
{"oneOf":[{"$ref":"CompiledScriptCondition"},{"$ref":"CompiledPromptCondition"},{"$ref":"CompiledValueVariableCondition"}]}
AnyCondition
{"anyOf":[{"$ref":"ScriptCondition"},{"$ref":"PromptCondition"},{"$ref":"ExpressionCondition"}]}
AnyJumpProgramCommand
{"anyOf":[{"$ref":"EventJumpProgramCommand"},{"$ref":"OnJumpProgramCommand"}]}
AnyProgramCommand
{"anyOf":[{"$ref":"AnyJumpProgramCommand"},{"$ref":"AnyPushProgramCommand"}]}
AnyProgramEvent
{"anyOf":[{"$ref":"IntentProgramEvent"},{"$ref":"EventProgramEvent"},{"$ref":"GeneralProgramEvent"}]}
AnyPushProgramCommand
{"anyOf":[{"$ref":"EventPushProgramCommand"},{"$ref":"OnPushProgramCommand"}]}
ApiCallToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["api-call"],"x-enumNames":["API_CALL"]} |
toolID · required | {"type":"string"} |
ApiNodeDataKeyValue
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
val · required | {"type":"string"} |
AssemblyAISTTLanguage
{"type":"string","enum":["multi","en","ar","da","nl","fi","fr","de","he","hi","it","ja","zh","no","pt","es","sv","tr","vi"],"x-enumNames":["MULTI","ENGLISH","ARABIC","DANISH","DUTCH","FINNISH","FRENCH","GERMAN","HEBREW","HINDI","ITALIAN","JAPANESE","MANDARIN","NORWEGIAN","PORTUGUESE","SPANISH","SWEDISH","TURKISH","VIETNAMESE"]}
AssemblyAISTTMode
{"type":"string","enum":["min_latency","balanced","max_accuracy"],"x-enumNames":["MIN_LATENCY","BALANCED","MAX_ACCURACY"]}
AssemblyAISTTModel
{"type":"string","enum":["universal-streaming-english","universal-3-5-pro"],"x-enumNames":["UNIVERSAL_STREAMING_ENGLISH","UNIVERSAL_3_5_PRO"]}
AssemblyAISTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["assemblyai"],"x-enumNames":["ASSEMBLYAI"]} |
model | {"allOf":[{"$ref":"AssemblyAISTTModel"}]} |
mode | {"allOf":[{"$ref":"AssemblyAISTTMode"}]} |
language | {"allOf":[{"$ref":"AssemblyAISTTLanguage"}]} |
keyterms | {"type":"string"} |
confidenceThreshold | {"default":0.7,"type":"number"} |
maxTurnSilence | {"default":2400,"type":"number"} |
minTurnSilence | {"default":160,"type":"number"} |
Assistant
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
version · required | {"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991} |
folderID | {"default":null,"nullable":true,"type":"number"} |
isDeleted | {"nullable":true,"type":"boolean"} |
description | {"default":null,"nullable":true,"type":"string"} |
workspaceID · required | {"type":"string"} |
activeEnvironmentID · required | @deprecated use project.environments instead with environments projects {"type":"string"} |
AssistantExportData
{"type":"object"}
| Property | Definition |
|---|---|
secrets | {"type":"array","items":{"$ref":"Secret"}} |
project · required | {"$ref":"Project"} |
_version | {"type":"string"} |
programs | {"type":"object","additionalProperties":{"$ref":"Program"}} |
assistant | {"nullable":true,"allOf":[{"$ref":"Assistant"}]} |
variableStates | {"type":"array","items":{"$ref":"VariableState"}} |
transcriptEvaluations | {"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["boolean"],"description":"The type of binary evaluations.","x-enumNames":["BOOLEAN"]},"truePrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should evaluate as 'true'."},"falsePrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should evaluate as 'false'."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","truePrompt","falsePrompt","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["number"],"description":"The type of rating evaluations.","x-enumNames":["NUMBER"]},"minimumValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The lowest rating that can be applied."},"minimumPrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should receive lower ratings."},"maximumValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The highest rating that can be applied."},"maximumPrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should receive higher ratings."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","minimumValue","minimumPrompt","maximumValue","maximumPrompt","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["string"],"description":"The type of text evaluations.","x-enumNames":["STRING"]},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["option"],"description":"The type of options evaluations.","x-enumNames":["OPTION"]},"options":{"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"TranscriptEvaluationOptionSchema"},"description":"The options that should be evaluated for."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","options","default"],"additionalProperties":false}]}} |
version · required | {"$ref":"Version"} |
diagrams · required | {"type":"object","additionalProperties":{"$ref":"Diagram"}} |
intents | {"type":"array","items":{"$ref":"Intent"}} |
utterances | {"type":"array","items":{"$ref":"Utterance"}} |
requiredEntities | {"type":"array","items":{"$ref":"RequiredEntity"}} |
responses | {"type":"array","items":{"$ref":"Response"}} |
responseMessages | {"type":"array","items":{"$ref":"ResponseMessage"}} |
responseDiscriminators | {"type":"array","items":{"$ref":"ResponseDiscriminator"}} |
functions | {"type":"array","items":{"$ref":"Function"}} |
functionPaths | {"type":"array","items":{"$ref":"FunctionPath"}} |
functionVariables | {"type":"array","items":{"$ref":"FunctionVariable"}} |
flows | {"type":"array","items":{"$ref":"Flow"}} |
agents | {"type":"array","items":{"$ref":"Agent"}} |
agentAPITools | {"default":[],"type":"array","items":{"$ref":"AgentAPITool"}} |
agentFlowTools | {"default":[],"type":"array","items":{"$ref":"AgentFlowTool"}} |
agentPathTools | {"type":"array","items":{"$ref":"AgentPathTool"}} |
agentFunctionTools | {"type":"array","items":{"$ref":"AgentFunctionTool"}} |
agentIntegrationTools | {"default":[],"type":"array","items":{"$ref":"AgentIntegrationTool"}} |
agentFlowToolVariables | {"default":[],"type":"array","items":{"$ref":"AgentFlowToolVariable"}} |
agentPathToolVariables | {"type":"array","items":{"$ref":"AgentPathToolVariable"}} |
agentMcpIntegrationTools | {"default":[],"type":"array","items":{"$ref":"AgentMcpIntegrationTool"}} |
events | {"type":"array","items":{"$ref":"Event"}} |
entities | {"type":"array","items":{"$ref":"Entity"}} |
entityVariants | {"type":"array","items":{"$ref":"EntityVariant"}} |
folders | {"type":"array","items":{"$ref":"Folder"}} |
prompts | {"type":"array","items":{"$ref":"Prompt"}} |
promptMessages | {"type":"array","items":{"$ref":"PromptMessage"}} |
apiTools | {"type":"array","items":{"$ref":"APITool"}} |
apiToolInputVariables | {"type":"array","items":{"$ref":"APIToolInputVariable"}} |
simulations | {"type":"array","items":{"$ref":"Simulation"}} |
simulationTurns | {"type":"array","items":{"$ref":"SimulationTurn"}} |
simulationTurnTests | {"type":"array","items":{"$ref":"SimulationTurnTest"}} |
variables | {"type":"array","items":{"$ref":"Variable"}} |
workflows | {"type":"array","items":{"$ref":"Workflow"}} |
attachments | {"type":"array","items":{"$ref":"AnyAttachment"}} |
cardButtons | {"type":"array","items":{"$ref":"CardButton"}} |
integrationTools | {"type":"array","items":{"$ref":"IntegrationTool"}} |
mcpIntegrationTools | {"type":"array","items":{"$ref":"McpIntegrationTool"}} |
mcpServers | {"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedByID":{"type":"number"},"assistantID":{"type":"string"},"environmentID":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":64},"folderID":{"nullable":true,"type":"string"},"createdByID":{"type":"number"},"image":{"default":null,"nullable":true,"type":"string"},"description":{"default":null,"nullable":true,"type":"string"},"specification":{"default":"2025-03-26","allOf":[{"$ref":"McpServerSpecification"}]},"url":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"headers":{"default":null,"nullable":true,"type":"array","items":{"$ref":"McpServerHeaderEntry"}},"authType":{"default":"custom","allOf":[{"$ref":"McpServerAuthType"}]},"oauthMetadata":{"default":null,"nullable":true,"allOf":[{"$ref":"McpServerOAuthMetadata"}]}},"required":["id","createdAt","updatedAt","updatedByID","assistantID","name","folderID","createdByID"]}} |
mcpServerTools | {"type":"array","items":{"$ref":"McpServerTool"}} |
personas | {"type":"array","items":{"$ref":"Persona"}} |
kbDocumentVersions | {"type":"array","items":{"$ref":"KBDocumentVersionBackup"}} |
kbSettings | {"nullable":true,"allOf":[{"$ref":"KBSettingsBackup"}]} |
kbDocumentMetadataM2M | {"type":"array","items":{"$ref":"KBDocumentMetadataM2MBackup"}} |
AutomaticReprompt
{"type":"object"}
| Property | Definition |
|---|---|
params · required | {"nullable":true,"allOf":[{"$ref":"AutomaticRepromptParams"}]} |
AutomaticRepromptParams
{"type":"object"}
| Property | Definition |
|---|---|
model | {"allOf":[{"$ref":"AIModel"}]} |
system | {"type":"string"} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
BackgroundAudioSettings
{"type":"object"}
| Property | Definition |
|---|---|
volume | {"default":0.75,"type":"number","minimum":0,"maximum":1} |
CallForwardAddressType
{"type":"string","enum":["phone","sip"],"x-enumNames":["PHONE","SIP"]}
CardAttachment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["card"],"x-enumNames":["CARD"]} |
title · required | {"$ref":"Markup"} |
mediaID · required | {"nullable":true,"type":"string"} |
description · required | {"$ref":"Markup"} |
buttonOrder · required | {"type":"array","items":{"type":"string"}} |
CardButton
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
label · required | {"$ref":"Markup"} |
cardID · required | {"type":"string"} |
CartesiaSTTLanguage
{"type":"string","enum":["en","af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"x-enumNames":["ENGLISH","AFRIKAANS","ARABIC","ARMENIAN","AZERBAIJANI","BELARUSIAN","BOSNIAN","BULGARIAN","CATALAN","CHINESE","CROATIAN","CZECH","DANISH","DUTCH","ESTONIAN","FINNISH","FRENCH","GALICIAN","GERMAN","GREEK","HEBREW","HINDI","HUNGARIAN","ICELANDIC","INDONESIAN","ITALIAN","JAPANESE","KANNADA","KAZAKH","KOREAN","LATVIAN","LITHUANIAN","MACEDONIAN","MALAY","MARATHI","MAORI","NEPALI","NORWEGIAN","PERSIAN","POLISH","PORTUGUESE","ROMANIAN","RUSSIAN","SERBIAN","SLOVAK","SLOVENIAN","SPANISH","SWAHILI","SWEDISH","TAGALOG","TAMIL","THAI","TURKISH","UKRAINIAN","URDU","VIETNAMESE","WELSH"]}
CartesiaSTTModel
{"type":"string","enum":["ink-whisper","ink-2"],"x-enumNames":["INK_WHISPER","INK_2"]}
CartesiaSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["cartesia"],"x-enumNames":["CARTESIA"]} |
model · required | {"$ref":"CartesiaSTTModel"} |
language · required | {"$ref":"CartesiaSTTLanguage"} |
CartesiaVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["cartesia"],"x-enumNames":["CARTESIA"]} |
model · required | {"type":"string"} |
voice · required | {"type":"string"} |
settings | {"type":"object","properties":{"speed":{"type":"number","minimum":0.6,"maximum":1.5}}} |
Channel
{"type":"string","enum":["default"],"x-enumNames":["DEFAULT"]}
CodeText
{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"MarkupVariableReference"},{"$ref":"MarkupEntityReference"}]}}
CompiledAPITool
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string","maxLength":255} |
description · required | {"nullable":true,"type":"string"} |
apiCall · required | {"type":"object","properties":{"url":{"type":"string"},"body":{"type":"array","items":{"$ref":"ApiNodeDataKeyValue"}},"method":{"$ref":"APINodeMethodType"},"params":{"type":"array","items":{"$ref":"ApiNodeDataKeyValue"}},"headers":{"type":"array","items":{"$ref":"ApiNodeDataKeyValue"}},"content":{"type":"string"},"bodyInputType":{"$ref":"APINodeBodyType"},"selected_action":{"$ref":"APINodeActionType"}},"required":["url","body","method","params","headers","content","bodyInputType","selected_action"]} |
toolName | {"type":"string"} |
timeoutMs | {"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"CompiledAPIToolInputVariable"}} |
hasToolNameWarning | {"type":"boolean"} |
CompiledAPIToolInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
CompiledAgent
{"type":"object"}
| Property | Definition |
|---|---|
settings · required | {"$ref":"AgentSettings"} |
isOperator | {"default":false,"type":"boolean"} |
description · required | {"nullable":true,"type":"string"} |
skipTurnTool | {"nullable":true,"allOf":[{"$ref":"CompiledAgentSkipTurnTool"}]} |
name | {"default":"","type":"string","maxLength":255} |
toolName | {"type":"string"} |
endTool | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentEndTool"}]} |
cardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentCardTool"}]} |
buttonTool | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentButtonTool"}]} |
carouselTool | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentCarouselTool"}]} |
webSearchTool · required | {"nullable":true,"allOf":[{"$ref":"CompiledAgentWebSearchTool"}]} |
apiTools | {"type":"array","items":{"$ref":"CompiledAgentAPITool"}} |
flowTools | {"type":"array","items":{"$ref":"CompiledAgentFlowTool"}} |
pathTools · required | {"type":"array","items":{"$ref":"CompiledAgentPathTool"}} |
instructions · required | {"nullable":true,"type":"string"} |
functionTools · required | {"type":"array","items":{"$ref":"CompiledAgentFunctionTool"}} |
callForwardTool | {"nullable":true,"allOf":[{"$ref":"CompiledAgentCallForwardTool"}]} |
integrationTools | {"type":"array","items":{"$ref":"CompiledAgentIntegrationTool"}} |
knowledgeBaseTool · required | {"nullable":true,"allOf":[{"$ref":"CompiledAgentKnowledgeBaseTool"}]} |
hasToolNameWarning | {"type":"boolean"} |
mcpIntegrationTools | {"type":"array","items":{"$ref":"CompiledAgentMcpIntegrationTool"}} |
CompiledAgentAPITool
{"type":"object"}
| Property | Definition |
|---|---|
apiToolID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
asyncExecution | {"default":false,"type":"boolean"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
CompiledAgentButtonTool / CompiledAgentCardTool / CompiledAgentCarouselTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
description · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
CompiledAgentCallForwardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
address · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
extension | {"type":"string"} |
description · required | {"type":"string"} |
addressType · required | {"$ref":"CallForwardAddressType"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
callerIDPassthrough | {"type":"boolean"} |
CompiledAgentEndTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
CompiledAgentFlowTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
flowID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
variables · required | {"type":"array","items":{"$ref":"CompiledAgentFlowToolVariable"}} |
CompiledAgentFlowToolVariable / CompiledAgentPathToolVariable
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
required · required | {"type":"boolean"} |
description · required | {"nullable":true,"type":"string"} |
CompiledAgentFunctionTool
{"type":"object"}
| Property | Definition |
|---|---|
functionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
asyncExecution | {"default":false,"type":"boolean"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
CompiledAgentIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
integrationToolID · required | {"type":"string"} |
extendedInputVariables | {"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolExtendedInputVariable"}} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
CompiledAgentKnowledgeBaseMetadataKeyFilter
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue · required | {"nullable":true,"type":"string"} |
key · required | {"type":"string"} |
CompiledAgentKnowledgeBaseTool
{"type":"object"}
| Property | Definition |
|---|---|
query | {"nullable":true,"type":"string"} |
enabled · required | {"type":"boolean"} |
filters | {"type":"array","items":{"$ref":"CompiledAgentKnowledgeBaseMetadataKeyFilter"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
chunkLimit | {"nullable":true,"type":"number"} |
queryMode | {"allOf":[{"$ref":"AgentKnowledgeBaseToolQueryMode"}]} |
sourceUrlsCount | {"nullable":true,"type":"number"} |
description · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
CompiledAgentMcpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
mcpIntegrationToolID · required | {"type":"string"} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
CompiledAgentPathTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
description · required | {"nullable":true,"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
toolName | {"type":"string"} |
variables · required | {"type":"array","items":{"$ref":"CompiledAgentPathToolVariable"}} |
hasToolNameWarning | {"type":"boolean"} |
CompiledAgentToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
prompts | {"nullable":true,"type":"object","properties":{"delay":{"type":"array","items":{"type":"string"}},"failure":{"type":"array","items":{"type":"string"}},"execution":{"type":"array","items":{"type":"string"}},"completion":{"type":"array","items":{"type":"string"}}}} |
generative | This field is deprecated. Use prompts instead. {"deprecated":true,"type":"object","properties":{"delay":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"execution":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"ToolMessageGenerative"}]}}} |
CompiledAgentWebSearchTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description | {"type":"string"} |
allowedDomains | {"nullable":true,"type":"array","items":{"type":"string"}} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"CompiledAgentToolMessages"}]} |
CompiledConditionAssertion
{"type":"object"}
| Property | Definition |
|---|---|
lhs · required | {"type":"string"} |
rhs · required | {"type":"string"} |
operation · required | {"$ref":"ConditionOperation"} |
CompiledCrewNodeDataAgent
{"type":"object"}
| Property | Definition |
|---|---|
agentID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CompiledCrewNodeDataRequiredVariable"}} |
condition | {"nullable":true,"allOf":[{"$ref":"CompiledValueVariableCondition"}]} |
CompiledCrewNodeDataFlow
{"type":"object"}
| Property | Definition |
|---|---|
flowID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CompiledCrewNodeDataRequiredVariable"}} |
condition | {"nullable":true,"allOf":[{"$ref":"CompiledValueVariableCondition"}]} |
CompiledCrewNodeDataRequiredVariable
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
CompiledEntity
{"type":"object"}
| Property | Definition |
|---|---|
variants · required | {"nullable":true,"type":"array","items":{"$ref":"CompiledEntityVariant"}} |
classifier · required | {"nullable":true,"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
CompiledEntityVariant
{"type":"object"}
| Property | Definition |
|---|---|
value · required | {"type":"string"} |
synonyms · required | {"type":"array","items":{"type":"string"}} |
CompiledFlow
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string","minLength":1,"maxLength":255} |
diagramID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
toolName | {"type":"string"} |
hasToolNameWarning | {"type":"boolean"} |
CompiledFunctionDefinition
{"type":"object"}
| Property | Definition |
|---|---|
name | {"type":"string"} |
toolName | {"type":"string"} |
hasToolNameWarning | {"type":"boolean"} |
codeId · required | Amazon S3 bucket key of the .js file containing this Function's code {"type":"string"} |
description | {"nullable":true,"type":"string"} |
inputVars · required | Mapping of input variable name to its variable declaration. {"type":"object","additionalProperties":{"$ref":"CompiledFunctionVariableDeclaration"}} |
outputVars · required | Mapping of output variable name to its variable declaration. {"type":"object","additionalProperties":{"$ref":"CompiledFunctionVariableDeclaration"}} |
pathCodes · required | List of valid return codes for a function {"type":"array","items":{"type":"string"}} |
timeoutMs | {"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991} |
CompiledFunctionVariableDeclaration
{"type":"object"}
| Property | Definition |
|---|---|
type · required | The type of the Function variable. Used to render suitable UI and perform data validation. {"type":"string","enum":["any","text","date","image","number","boolean","string"],"x-enumNames":["ANY","TEXT","DATE","IMAGE","NUMBER","BOOLEAN","STRING"]} |
description | {"nullable":true,"type":"string"} |
CompiledIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string","maxLength":255} |
toolName · required | {"$ref":"IntegrationToolName"} |
description · required | {"nullable":true,"type":"string"} |
toolProvider · required | {"$ref":"IntegrationToolProvider"} |
CompiledMcpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
toolName · required | {"type":"string"} |
inputSchema · required | {"$ref":"JsonSchema"} |
mcpServerID · required | {"type":"string"} |
CompiledMcpServer
{"type":"object"}
| Property | Definition |
|---|---|
specification | {"default":"2025-03-26","allOf":[{"$ref":"McpServerSpecification"}]} |
id | {"type":"string"} |
name | {"type":"string"} |
url | {"type":"string"} |
headers | {"type":"object","additionalProperties":{"type":"string"}} |
authType | {"allOf":[{"$ref":"McpServerAuthType"}]} |
CompiledMcpServerTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
toolName · required | {"type":"string"} |
description | {"nullable":true,"type":"string"} |
inputSchema · required | {"$ref":"JsonSchema"} |
mcpServerID · required | {"type":"string"} |
CompiledMessage
{"type":"object"}
| Property | Definition |
|---|---|
variants · required | {"type":"object","additionalProperties":{"type":"array","items":{"$ref":"CompiledResponseMessage"}}} |
CompiledPrompt
{"type":"object"}
| Property | Definition |
|---|---|
settings · required | {"$ref":"PromptSettings"} |
system · required | {"type":"string"} |
messages · required | {"type":"array","items":{"$ref":"AIMessageSimple"}} |
CompiledPromptCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["prompt"],"x-enumNames":["PROMPT"]} |
data · required | {"$ref":"CompiledPromptConditionData"} |
CompiledPromptConditionData / CompiledValueVariableConditionData
{"type":"object"}
| Property | Definition |
|---|---|
matchAll · required | {"type":"boolean"} |
assertions · required | {"type":"array","items":{"$ref":"CompiledConditionAssertion"}} |
CompiledResponseMessage
{"type":"object"}
| Property | Definition |
|---|---|
condition · required | {"nullable":true,"allOf":[{"$ref":"AnyCompiledCondition"}]} |
data · required | {"$ref":"CompiledResponseMessageData"} |
CompiledResponseMessageData
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"type":"array","items":{}} |
delay · required | {"nullable":true,"type":"number"} |
CompiledScriptCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["script"],"x-enumNames":["SCRIPT"]} |
data · required | {"$ref":"CompiledScriptConditionData"} |
CompiledScriptConditionData
{"type":"object"}
| Property | Definition |
|---|---|
code · required | {"type":"string"} |
CompiledSystemVariable
{"type":"object"}
| Property | Definition |
|---|---|
isSystem · required | {"type":"boolean","enum":[true],"x-enumNames":["TRUE"]} |
description | {"nullable":true,"type":"string"} |
defaultValue · required | {"nullable":true,"type":"string"} |
resetAfter · required | {"type":"string","enum":["never","session"],"x-enumNames":["NEVER","EACH_SESSION"]} |
CompiledToolNodeDataVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
defaultValue · required | {"nullable":true,"type":"string"} |
draftDefaultValue | {"type":"string"} |
CompiledUserVariable
{"type":"object"}
| Property | Definition |
|---|---|
isSystem · required | {"type":"boolean","enum":[false],"x-enumNames":["FALSE"]} |
description | {"nullable":true,"type":"string"} |
defaultValue · required | {"nullable":true,"type":"string"} |
resetAfter · required | {"type":"string","enum":["never","session"],"x-enumNames":["NEVER","EACH_SESSION"]} |
datatype · required | {"$ref":"VariableDatatype"} |
isArray · required | {"type":"boolean"} |
CompiledValueVariableCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["value-variable"],"x-enumNames":["VALUE_VARIABLE"]} |
data · required | {"$ref":"CompiledValueVariableConditionData"} |
CompiledVariable
{"oneOf":[{"$ref":"CompiledSystemVariable"},{"$ref":"CompiledUserVariable"}]}
ConditionAssertion
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
lhs · required | {"$ref":"ConditionAssertionLhs"} |
rhs · required | {"$ref":"Markup"} |
operation | {"default":"is","allOf":[{"$ref":"ConditionOperation"}]} |
ConditionAssertionLhs
{"type":"object"}
| Property | Definition |
|---|---|
variableID · required | {"nullable":true,"type":"string"} |
path | {"type":"string"} |
ConditionOperation
{"type":"string","enum":["is","is_not","greater_than","greater_or_equal","less_than","less_or_equal","contains","not_contains","starts_with","ends_with","is_empty","is_not_empty"],"x-enumNames":["IS","IS_NOT","GREATER_THAN","GREATER_OR_EQUAL","LESS_THAN","LESS_OR_EQUAL","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","IS_EMPTY","IS_NOT_EMPTY"]}
ConditionPromptAssertion
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
lhs | {"allOf":[{"$ref":"PromptConditionAssertionLhs"}]} |
rhs · required | {"$ref":"Markup"} |
operation | {"default":"is","allOf":[{"$ref":"ConditionOperation"}]} |
ContentPart
{"anyOf":[{"$ref":"TextContentPart"},{"$ref":"ImageContentPart"},{"$ref":"DocumentContentPart"}]}
CrewNodeDataAgent
{"type":"object"}
| Property | Definition |
|---|---|
agentID · required | {"type":"string"} |
condition | {"nullable":true,"allOf":[{"$ref":"ExpressionCondition"}]} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CrewNodeDataRequiredVariable"}} |
CrewNodeDataFlow
{"type":"object"}
| Property | Definition |
|---|---|
flowID · required | {"type":"string"} |
condition | {"nullable":true,"allOf":[{"$ref":"ExpressionCondition"}]} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CrewNodeDataRequiredVariable"}} |
CrewNodeDataRequiredVariable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
variableOrEntityID · required | {"nullable":true,"type":"string"} |
DTMFDelimiter
{"type":"string","enum":["#","*"],"x-enumNames":["#","*"]}
DeepgramASRSettings
{"type":"object"}
| Property | Definition |
|---|---|
punctuationWaitMS | {"type":"number"} |
partialWaitMS | {"type":"number"} |
silenceWaitMS | {"type":"number"} |
interruptionWaitWords | {"type":"number"} |
audioCue | {"nullable":true,"type":"number"} |
backgroundAudio | {"nullable":true,"type":"string"} |
locale | {"allOf":[{"$ref":"DeepgramSTTLanguage"}]} |
keywords | {"type":"string"} |
DeepgramSTTLanguage
{"type":"string","enum":["multi","ar","ar-AE","ar-DZ","ar-EG","ar-IQ","ar-IR","ar-JO","ar-KW","ar-LB","ar-MA","ar-PS","ar-QA","ar-SA","ar-SD","ar-SY","ar-TD","ar-TN","be","bg","bn","bs","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","et","fa","fi","fr","fr-CA","he","hi","hr","hu","id","it","ja","kn","ko","ko-KR","lt","lv","mk","mr","ms","nl","nl-BE","no","pl","pt","pt-BR","pt-PT","ro","ru","sk","sl","sr","sv","sv-SE","ta","te","th","tl","tr","uk","ur","vi","zh","zh-HK","zh-TW"],"x-enumNames":["MULTI","AR","AR_AE","AR_DZ","AR_EG","AR_IQ","AR_IR","AR_JO","AR_KW","AR_LB","AR_MA","AR_PS","AR_QA","AR_SA","AR_SD","AR_SY","AR_TD","AR_TN","BE","BG","BN","BS","CA","CS","DA","DA_DK","DE","DE_CH","EL","EN","EN_AU","EN_GB","EN_IN","EN_NZ","EN_US","ES","ES_419","ET","FA","FI","FR","FR_CA","HE","HI","HR","HU","ID","IT","JA","KN","KO","KO_KR","LT","LV","MK","MR","MS","NL","NL_BE","NO","PL","PT","PT_BR","PT_PT","RO","RU","SK","SL","SR","SV","SV_SE","TA","TE","TH","TL","TR","UK","UR","VI","ZH","ZH_HK","ZH_TW"]}
DeepgramSTTModel
{"type":"string","enum":["nova-2","nova-3","nova-3-medical","flux"],"x-enumNames":["NOVA_2","NOVA_3","NOVA_3_MEDICAL","FLUX"]}
DeepgramSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["deepgram"],"x-enumNames":["DEEPGRAM"]} |
model | {"allOf":[{"$ref":"DeepgramSTTModel"}]} |
locale | {"allOf":[{"$ref":"DeepgramSTTLanguage"}]} |
keywords | {"type":"string"} |
partialWaitMS | {"type":"number"} |
silenceWaitMS | {"type":"number"} |
punctuationWaitMS | {"type":"number"} |
interruptionWaitWords | {"type":"number"} |
EOTTimeout | {"type":"number"} |
EOTThreshold | {"type":"number"} |
languageHints | {"type":"array","items":{"$ref":"DeepgramSTTLanguage"}} |
Diagram / StableExportDiagram
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
name · required | {"type":"string"} |
type | {"allOf":[{"$ref":"DiagramType"}]} |
zoom · required | {"type":"number"} |
nodes · required | {"type":"object","additionalProperties":{"$ref":"DiagramNode"}} |
offsetX · required | {"type":"number"} |
offsetY · required | {"type":"number"} |
modified · required | {"type":"number"} |
diagramID · required | {"type":"string"} |
versionID · required | {"type":"string"} |
creatorID · required | {"type":"number"} |
variables · required | {"type":"array","items":{"type":"string"}} |
children | {"type":"array","items":{"type":"string"}} |
menuItems | @deprecated not used anymore {"type":"array","items":{"$ref":"DiagramMenuItem"}} |
menuNodeIDs | @deprecated in favor of menuItems {"type":"array","items":{"type":"string"}} |
intentStepIDs | @deprecated in favor of menuNodeIDs {"type":"array","items":{"type":"string"}} |
DiagramMenuItem / VersionFolderItem
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
sourceID · required | {"type":"string"} |
DiagramNode
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
data · required | {"type":"object","additionalProperties":{}} |
nodeID · required | {"type":"string"} |
coords | {"type":"array","items":{"anyOf":[{"type":"number"},{"type":"number"}]},"minItems":2,"maxItems":2} |
DiagramType
{"type":"string","enum":["TOPIC","GROUP","TEMPLATE","COMPONENT"],"x-enumNames":["TOPIC","GROUP","TEMPLATE","COMPONENT"]}
DocumentContentPart
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["document"],"x-enumNames":["DOCUMENT"]} |
url | {"type":"string","format":"uri"} |
data | {"type":"string"} |
mimeType | {"type":"string","enum":["application/pdf"],"x-enumNames":["APPLICATION_PDF"]} |
DocumentMetadataEntry
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
values · required | {"type":"array","items":{"$ref":"DocumentMetadataValue"}} |
DocumentMetadataValue
{"type":"object"}
| Property | Definition |
|---|---|
value · required | {"type":"string"} |
id · required | {"type":"string"} |
ElevenLabsSTTLanguage
{"type":"string","enum":["afr","amh","ara","hye","asm","ast","aze","bel","ben","bos","bul","mya","yue","cat","ceb","nya","hrv","ces","dan","nld","eng","est","fil","fin","fra","ful","glg","lug","kat","deu","ell","guj","hau","heb","hin","hun","isl","ibo","ind","gle","ita","jpn","jav","kea","kan","kaz","khm","kor","kur","kir","lao","lav","lin","lit","luo","ltz","mkd","msa","mal","mlt","zho","mri","mar","mon","nep","nso","nor","oci","ori","pus","fas","pol","por","pan","ron","rus","srp","sna","snd","slk","slv","som","spa","swa","swe","tam","tgk","tel","tha","tur","ukr","umb","urd","uzb","vie","cym","wol","xho","zul"],"x-enumNames":["AFRIKAANS","AMHARIC","ARABIC","ARMENIAN","ASSAMESE","ASTURIAN","AZERBAIJANI","BELARUSIAN","BENGALI","BOSNIAN","BULGARIAN","BURMESE","CANTONESE","CATALAN","CEBUANO","CHICHEWA","CROATIAN","CZECH","DANISH","DUTCH","ENGLISH","ESTONIAN","FILIPINO","FINNISH","FRENCH","FULAH","GALICIAN","GANDA","GEORGIAN","GERMAN","GREEK","GUJARATI","HAUSA","HEBREW","HINDI","HUNGARIAN","ICELANDIC","IGBO","INDONESIAN","IRISH","ITALIAN","JAPANESE","JAVANESE","KABUVERDIANU","KANNADA","KAZAKH","KHMER","KOREAN","KURDISH","KYRGYZ","LAO","LATVIAN","LINGALA","LITHUANIAN","LUO","LUXEMBOURGISH","MACEDONIAN","MALAY","MALAYALAM","MALTESE","MANDARIN_CHINESE","MAORI","MARATHI","MONGOLIAN","NEPALI","NORTHERN_SOTHO","NORWEGIAN","OCCITAN","ODIA","PASHTO","PERSIAN","POLISH","PORTUGUESE","PUNJABI","ROMANIAN","RUSSIAN","SERBIAN","SHONA","SINDHI","SLOVAK","SLOVENIAN","SOMALI","SPANISH","SWAHILI","SWEDISH","TAMIL","TAJIK","TELUGU","THAI","TURKISH","UKRAINIAN","UMBUNDU","URDU","UZBEK","VIETNAMESE","WELSH","WOLOF","XHOSA","ZULU"]}
ElevenLabsSTTModel
{"type":"string","enum":["scribe_v2_realtime"],"x-enumNames":["SCRIBE_V_2_REALTIME"]}
ElevenLabsSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["elevenlabs"],"x-enumNames":["ELEVENLABS"]} |
model · required | {"$ref":"ElevenLabsSTTModel"} |
language · required | {"$ref":"ElevenLabsSTTLanguage"} |
commitStrategy | {"type":"string","enum":["vad","manual"],"x-enumNames":["VAD","MANUAL"]} |
vadSilenceThresholdSecs | {"type":"number","minimum":0.3,"maximum":3} |
vadThreshold | {"type":"number","minimum":0.1,"maximum":0.9} |
minSpeechDurationMS | {"type":"number","minimum":50,"maximum":2000} |
minSilenceDurationMS | {"type":"number","minimum":50,"maximum":2000} |
ElevenLabsVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["elevenlabs"],"x-enumNames":["ELEVENLABS"]} |
model · required | {"type":"string"} |
voice · required | {"type":"string"} |
useCustomVoice | {"type":"boolean"} |
settings · required | {"type":"object","properties":{"speed":{"type":"number","minimum":0.7,"maximum":1.3},"style":{"type":"number","minimum":0,"maximum":1},"stability":{"type":"number","minimum":0,"maximum":1},"speaker_boost":{"type":"boolean"},"similarity_boost":{"type":"number","minimum":0,"maximum":1}}} |
pronunciation_dictionaries | {"type":"array","items":{"type":"object","properties":{"pronunciation_dictionary_id":{"type":"string"},"version_id":{"type":"string"}},"required":["pronunciation_dictionary_id"]}} |
Entity
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
color · required | {"type":"string"} |
isArray · required | {"type":"boolean"} |
classifier · required | {"nullable":true,"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
EntityVariant
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
value · required | {"type":"string"} |
language · required | {"$ref":"Language"} |
synonyms · required | {"type":"array","items":{"type":"string"}} |
entityID · required | {"type":"string"} |
Event
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
flowID | {"default":null,"nullable":true,"type":"string"} |
goesTo | {"default":null,"nullable":true,"allOf":[{"$ref":"EventGoesToType"}]} |
isSystem · required | {"type":"boolean"} |
requestName · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
EventGoesToType
{"type":"string","enum":["global_agent","flow","continue"],"x-enumNames":["GLOBAL_AGENT","FLOW","CONTINUE"]}
EventJumpProgramCommand
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["jump"],"x-enumNames":["JUMP"]} |
nextID · required | {"nullable":true,"type":"string"} |
platform | {"type":"string"} |
diagramID | {"nullable":true,"type":"string"} |
event · required | {"$ref":"AnyProgramEvent"} |
EventProgramEvent
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["event"],"x-enumNames":["EVENT"]} |
event · required | {"type":"string"} |
EventPushProgramCommand
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["push"],"x-enumNames":["PUSH"]} |
platform | {"type":"string"} |
diagramID | {"nullable":true,"type":"string"} |
event · required | {"$ref":"AnyProgramEvent"} |
ExportTextString
Rich text rendered as a string, with {name} for a variable, entity or secret reference and name for a tool, playbook or workflow reference. A chat-text leaf (a tool message example, a card or attachment description, a static no-match or no-reply prompt) carries markdown marks and escapes a literal *, _, ~, [, <u> or </u> with a backslash, as a message read does. A prompt leaf (instructions, persona, guidelines) carries markdown. Every other leaf is plain text with {name} references, no marks and no escapes: a URL, a header, query or body value, a default value, a condition operand, a set value, a code leaf, and an utterance leaf (entity references only). Outside a prompt-kind leaf, a variable, entity or secret whose name is outside the token grammar (letters, digits and underscores, at most 64 characters) renders as its id. A secret inside a prompt-kind leaf renders as its id rather than its name, matching the dedicated agent read. The export is read-only. Inside diagrams{}.nodes{}.data only the node types whose data carries rich text are rendered; every other node type ships in its stored object form.
{"type":"string"}
ExpressionCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["value-variable"],"x-enumNames":["VALUE_VARIABLE"]} |
matchAll · required | {"type":"boolean"} |
assertions · required | {"type":"array","items":{"$ref":"ConditionAssertion"}} |
FallbackMapping
{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","properties":{"provider":{"$ref":"AIProvider"},"model":{"$ref":"AIModel"}},"required":["provider","model"]}}}
FileAttachmentMetadata
{"type":"object"}
| Property | Definition |
|---|---|
filename · required | {"type":"string"} |
mimeType · required | {"type":"string"} |
description · required | {"type":"string"} |
Flow
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
diagramID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
Folder
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
scope · required | {"$ref":"FolderScope"} |
parentID · required | {"nullable":true,"type":"string"} |
FolderScope
{"type":"string","enum":["flow","event","agent","prompt","entity","intent","message","workflow","variable","function","simulation","knowledge-base"],"x-enumNames":["FLOW","EVENT","AGENT","PROMPT","ENTITY","INTENT","MESSAGE","WORKFLOW","VARIABLE","FUNCTION","SIMULATION","KNOWLEDGE_BASE"]}
Function
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
code · required | {"type":"string"} |
image · required | {"nullable":true,"type":"string"} |
pathOrder · required | {"type":"array","items":{"type":"string"}} |
description · required | {"nullable":true,"type":"string"} |
settings | {"nullable":true,"allOf":[{"$ref":"FunctionSettings"}]} |
FunctionPath
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
label · required | {"nullable":true,"type":"string"} |
functionID · required | {"type":"string"} |
FunctionToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["function"],"x-enumNames":["FUNCTION"]} |
toolID · required | {"type":"string"} |
FunctionVariable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
type · required | {"$ref":"FunctionVariableKind"} |
functionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
FunctionVariableKind
{"type":"string","enum":["input","output"],"x-enumNames":["INPUT","OUTPUT"]}
GeneralProgramEvent
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
name | {"type":"string"} |
GladiaSTTLanguage
{"type":"string","enum":["af","am","ar","as","az","ba","be","bg","bn","bo","br","bs","ca","cs","cy","da","de","el","en","es","et","eu","fa","fi","fo","fr","gl","gu","ha","haw","he","hi","hr","ht","hu","hy","id","is","it","ja","jw","ka","kk","km","kn","ko","la","lb","ln","lo","lt","lv","mg","mi","mk","ml","mn","mr","ms","mt","my","ne","nl","nn","no","oc","pa","pl","ps","pt","ro","ru","sa","sd","si","sk","sl","sn","so","sq","sr","su","sv","sw","ta","te","tg","th","tk","tl","tr","tt","uk","ur","uz","vi","yi","yo","zh"],"x-enumNames":["AFRIKAANS","AMHARIC","ARABIC","ASSAMESE","AZERBAIJANI","BASHKIR","BELARUSIAN","BULGARIAN","BENGALI","TIBETAN","BRETON","BOSNIAN","CATALAN","CZECH","WELSH","DANISH","GERMAN","GREEK","ENGLISH","SPANISH","ESTONIAN","BASQUE","PERSIAN","FINNISH","FAROESE","FRENCH","GALICIAN","GUJARATI","HAUSA","HAWAIIAN","HEBREW","HINDI","CROATIAN","HAITIAN_CREOLE","HUNGARIAN","ARMENIAN","INDONESIAN","ICELANDIC","ITALIAN","JAPANESE","JAVANESE","GEORGIAN","KAZAKH","KHMER","KANNADA","KOREAN","LATIN","LUXEMBOURGISH","LINGALA","LAO","LITHUANIAN","LATVIAN","MALAGASY","MAORI","MACEDONIAN","MALAYALAM","MONGOLIAN","MARATHI","MALAY","MALTESE","MYANMAR","NEPALI","DUTCH","NORWEGIAN_NYNORSK","NORWEGIAN","OCCITAN","PUNJABI","POLISH","PASHTO","PORTUGUESE","ROMANIAN","RUSSIAN","SANSKRIT","SINDHI","SINHALA","SLOVAK","SLOVENIAN","SHONA","SOMALI","ALBANIAN","SERBIAN","SUNDANESE","SWEDISH","SWAHILI","TAMIL","TELUGU","TAJIK","THAI","TURKMEN","TAGALOG","TURKISH","TATAR","UKRAINIAN","URDU","UZBEK","VIETNAMESE","YIDDISH","YORUBA","CHINESE"]}
GladiaSTTModel
{"type":"string","enum":["solaria-1"],"x-enumNames":["SOLARIA_1"]}
GladiaSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["gladia"],"x-enumNames":["GLADIA"]} |
model · required | {"$ref":"GladiaSTTModel"} |
endpointing · required | {"type":"number"} |
maxDurationWithoutEndpointing · required | {"type":"number"} |
languages · required | {"type":"array","items":{"$ref":"GladiaSTTLanguage"}} |
GoogleSTTLanguage
{"type":"string","enum":["auto","ca-ES","cmn-Hans-CN","hr-HR","da-DK","nl-NL","en-AU","en-GB","en-IN","en-US","fi-FI","fr-CA","fr-FR","de-DE","el-GR","hi-IN","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-US","sv-SE","tr-TR","uk-UA","vi-VN","ar-XA","ar-DZ","ar-BH","ar-EG","ar-IL","ar-JO","ar-KW","ar-LB","ar-MR","ar-MA","ar-OM","ar-QA","ar-SA","ar-PS","ar-SY","ar-TN","ar-AE","ar-YE","hy-AM","bn-BD","bn-IN","bg-BG","my-MM","ar-IQ","yue-Hant-HK","cmn-Hant-TW","cs-CZ","en-PH","et-EE","fil-PH","gu-IN","iw-IL","hu-HU","id-ID","kn-IN","km-KH","lo-LA","lv-LV","lt-LT","ms-MY","ml-IN","mr-IN","ne-NP","no-NO","fa-IR","pa-Guru-IN","sr-RS","sk-SK","sl-SI","es-MX","sw","ta-IN","te-IN","th-TH","uz-UZ"],"x-enumNames":["AUTO","CA_ES","CMN_HANS_CN","HR_HR","DA_DK","NL_NL","EN_AU","EN_GB","EN_IN","EN_US","FI_FI","FR_CA","FR_FR","DE_DE","EL_GR","HI_IN","IT_IT","JA_JP","KO_KR","PL_PL","PT_BR","PT_PT","RO_RO","RU_RU","ES_ES","ES_US","SV_SE","TR_TR","UK_UA","VI_VN","AR_XA","AR_DZ","AR_BH","AR_EG","AR_IL","AR_JO","AR_KW","AR_LB","AR_MR","AR_MA","AR_OM","AR_QA","AR_SA","AR_PS","AR_SY","AR_TN","AR_AE","AR_YE","HY_AM","BN_BD","BN_IN","BG_BG","MY_MM","AR_IQ","YUE_HANT_HK","CMN_HANT_TW","CS_CZ","EN_PH","ET_EE","FIL_PH","GU_IN","IW_IL","HU_HU","ID_ID","KN_IN","KM_KH","LO_LA","LV_LV","LT_LT","MS_MY","ML_IN","MR_IN","NE_NP","NO_NO","FA_IR","PA_GURU_IN","SR_RS","SK_SK","SL_SI","ES_MX","SW","TA_IN","TE_IN","TH_TH","UZ_UZ"]}
GoogleSTTModel
{"type":"string","enum":["chirp_3"],"x-enumNames":["CHIRP_3"]}
GoogleSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["google"],"x-enumNames":["GOOGLE"]} |
model · required | {"$ref":"GoogleSTTModel"} |
languages · required | {"type":"array","items":{"$ref":"GoogleSTTLanguage"}} |
GoogleTTSModelID
{"type":"string","enum":["standard","wavenet","neural2","polyglot","studio","Chirp3-HD","gemini-2.5-flash"],"x-enumNames":["STANDARD","WAVENET","NEURAL_2","POLYGLOT","STUDIO","CHIRP_3_HD","GEMINI_2_5_FLASH"]}
GoogleVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["google"],"x-enumNames":["GOOGLE"]} |
model | {"allOf":[{"$ref":"GoogleTTSModelID"}]} |
languageCode | {"type":"string"} |
voice · required | {"type":"string"} |
settings | {"type":"object","properties":{"prompt":{"type":"string"}}} |
ImageContentPart
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["image"],"x-enumNames":["IMAGE"]} |
url | {"type":"string","format":"uri"} |
data | {"type":"string"} |
mimeType | {"allOf":[{"$ref":"ImageMimeType"}]} |
ImageMimeType
{"type":"string","enum":["image/jpeg","image/png","image/gif","image/webp"],"x-enumNames":["IMAGE_JPEG","IMAGE_PNG","IMAGE_GIF","IMAGE_WEBP"]}
IntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
toolName · required | {"$ref":"IntegrationToolName"} |
description · required | {"nullable":true,"type":"string"} |
toolProvider · required | {"$ref":"IntegrationToolProvider"} |
IntegrationToolName
{"type":"string","enum":["example_dynamic_schema","zendesk_find_user","zendesk_find_group","zendesk_find_ticket","zendesk_create_ticket","zendesk_update_ticket","zendesk_add_ticket_comment","zendesk_update_organization","zendesk_find_latest_comment","salesforce_create_lead","salesforce_update_lead","salesforce_create_contact","salesforce_update_contact","salesforce_create_case","salesforce_update_case","salesforce_add_comment_to_case","shopify_get_products","shopify_get_order","shopify_cancel_order","shopify_update_order","google_sheets_create_spreadsheet","google_sheets_update_spreadsheet","google_sheets_read_spreadsheet","google_sheets_append_spreadsheet","google_sheets_read_row","google_gmail_send_email","airtable_create_records","airtable_delete_records","airtable_get_record","airtable_list_records","airtable_update_records","make_run_scenario","twilio_send_sms","hubspot_create_contact","hubspot_create_lead","hubspot_create_ticket","kustomer_find_customer","kustomer_create_customer","kustomer_update_customer","kustomer_find_conversation","kustomer_find_customer_conversations","kustomer_create_conversation","kustomer_update_conversation","kustomer_add_conversation_note","kustomer_add_conversation_tags","kustomer_find_latest_message","kustomer_find_team","kustomer_update_company"],"x-enumNames":["EXAMPLE_DYNAMIC_SCHEMA","ZENDESK_FIND_USER","ZENDESK_FIND_GROUP","ZENDESK_FIND_TICKET","ZENDESK_CREATE_TICKET","ZENDESK_UPDATE_TICKET","ZENDESK_ADD_TICKET_COMMENT","ZENDESK_UPDATE_ORGANIZATION","ZENDESK_FIND_LATEST_TICKET_COMMENT","SALESFORCE_CREATE_LEAD","SALESFORCE_UPDATE_LEAD","SALESFORCE_CREATE_CONTACT","SALESFORCE_UPDATE_CONTACT","SALESFORCE_CREATE_CASE","SALESFORCE_UPDATE_CASE","SALESFORCE_ADD_COMMENT_TO_CASE","SHOPIFY_GET_PRODUCTS","SHOPIFY_GET_ORDER","SHOPIFY_CANCEL_ORDER","SHOPIFY_UPDATE_ORDER","GOOGLE_SHEETS_CREATE_SPREADSHEET","GOOGLE_SHEETS_UPDATE_SPREADSHEET","GOOGLE_SHEETS_READ_SPREADSHEET","GOOGLE_SHEETS_APPEND_SPREADSHEET","GOOGLE_SHEETS_READ_ROW","GOOGLE_GMAIL_SEND_EMAIL","AIRTABLE_CREATE_RECORDS","AIRTABLE_DELETE_RECORDS","AIRTABLE_GET_RECORD","AIRTABLE_LIST_RECORDS","AIRTABLE_UPDATE_RECORDS","MAKE_RUN_SCENARIO","TWILIO_SEND_SMS","HUBSPOT_CREATE_CONTACT","HUBSPOT_CREATE_LEAD","HUBSPOT_CREATE_TICKET","KUSTOMER_FIND_CUSTOMER","KUSTOMER_CREATE_CUSTOMER","KUSTOMER_UPDATE_CUSTOMER","KUSTOMER_FIND_CONVERSATION","KUSTOMER_FIND_CUSTOMER_CONVERSATIONS","KUSTOMER_CREATE_CONVERSATION","KUSTOMER_UPDATE_CONVERSATION","KUSTOMER_ADD_CONVERSATION_NOTE","KUSTOMER_ADD_CONVERSATION_TAGS","KUSTOMER_FIND_LATEST_MESSAGE","KUSTOMER_FIND_TEAM","KUSTOMER_UPDATE_COMPANY"]}
IntegrationToolProvider
{"type":"string","enum":["make","zendesk","shopify","airtable","salesforce","hubspot","google_gmail","google_sheets","twilio","ujet","genesys","kustomer","dixa","sunshine","custom_handoff","example"],"x-enumNames":["MAKE","ZENDESK","SHOPIFY","AIRTABLE","SALESFORCE","HUBSPOT","GOOGLE_GMAIL","GOOGLE_SHEETS","TWILIO","UJET","GENESYS","KUSTOMER","DIXA","SUNSHINE","CUSTOM_HANDOFF","EXAMPLE"]}
IntegrationToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["integration"],"x-enumNames":["INTEGRATION"]} |
toolID · required | {"type":"string"} |
Intent
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
description · required | {"nullable":true,"type":"string"} |
entityOrder · required | {"type":"array","items":{"type":"string"}} |
automaticReprompt · required | {"type":"boolean"} |
automaticRepromptSettings · required | {"nullable":true,"allOf":[{"$ref":"AutomaticReprompt"}]} |
IntentAIParams
{"type":"object"}
| Property | Definition |
|---|---|
model · required | {"allOf":[{"$ref":"AIModel"}]} |
temperature · required | {"type":"number"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
IntentClassificationLLMSettings
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["llm"],"x-enumNames":["LLM"]} |
params · required | {"$ref":"IntentAIParams"} |
promptWrapper · required | {"nullable":true,"allOf":[{"$ref":"AIPromptWrapper"}]} |
IntentClassificationNLUSettings
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["nlu"],"x-enumNames":["NLU"]} |
params · required | {"type":"object","properties":{"confidence":{"type":"number"}},"required":["confidence"]} |
IntentClassificationRAGSettings
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["rag"],"x-enumNames":["RAG"]} |
params · required | {"$ref":"IntentAIParams"} |
promptWrapper · required | {"nullable":true,"allOf":[{"$ref":"AIPromptWrapper"}]} |
IntentClassificationSettings
{"oneOf":[{"$ref":"IntentClassificationLLMSettings"},{"$ref":"IntentClassificationNLUSettings"},{"$ref":"IntentClassificationRAGSettings"},{"$ref":"IntentClassificationSystemOneSettings"}]}
IntentClassificationSystemOneSettings
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["system-one"],"x-enumNames":["SYSTEM_ONE"]} |
params · required | {"type":"object","properties":{"confidence":{"type":"number"},"model":{"$ref":"SystemOneModel"}},"required":["confidence","model"]} |
IntentProgramEvent
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
intent · required | {"type":"string"} |
mappings | {"type":"array","items":{"$ref":"IntentProgramEventMapping"}} |
IntentProgramEventMapping
{"type":"object"}
| Property | Definition |
|---|---|
slot · required | {"type":"string"} |
variable · required | {"type":"string"} |
InterfaceConfig
{"type":"object"}
| Property | Definition |
|---|---|
layout | {"allOf":[{"$ref":"InterfaceConfigLayout"}]} |
theme | {"allOf":[{"$ref":"InterfaceConfigTheme"}]} |
launcher | {"allOf":[{"$ref":"InterfaceConfigLauncher"}]} |
header | {"allOf":[{"$ref":"InterfaceConfigHeader"}]} |
buttons | {"allOf":[{"$ref":"InterfaceConfigButtons"}]} |
menu | {"allOf":[{"$ref":"InterfaceConfigMenu"}]} |
start | {"allOf":[{"$ref":"InterfaceConfigStart"}]} |
messages | {"allOf":[{"$ref":"InterfaceConfigMessages"}]} |
composer | {"allOf":[{"$ref":"InterfaceConfigComposer"}]} |
end | {"allOf":[{"$ref":"InterfaceConfigEnd"}]} |
footer | {"allOf":[{"$ref":"InterfaceConfigFooter"}]} |
history | {"allOf":[{"$ref":"InterfaceConfigHistory"}]} |
transcript | {"allOf":[{"$ref":"InterfaceConfigTranscript"}]} |
sounds | {"allOf":[{"$ref":"InterfaceConfigSounds"}]} |
locale | {"allOf":[{"$ref":"InterfaceConfigLocale"}]} |
voice | {"allOf":[{"$ref":"InterfaceConfigVoice"}]} |
consent | {"allOf":[{"$ref":"InterfaceConfigConsent"}]} |
site | {"allOf":[{"$ref":"InterfaceConfigSite"}]} |
css | {"type":"string"} |
InterfaceConfigButton
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string","pattern":"^[a-z][a-z0-9-]*$"} |
action · required | {"type":"string","minLength":1} |
args | {"type":"object","additionalProperties":{}} |
label | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
icon | {"allOf":[{"$ref":"InterfaceConfigButtonIcon"}]} |
when | {"allOf":[{"$ref":"InterfaceConfigButtonWhen"}]} |
emphasis | {"allOf":[{"$ref":"InterfaceConfigButtonEmphasis"}]} |
enabled | {"type":"boolean"} |
InterfaceConfigButtonEmphasis
{"type":"string","enum":["primary","secondary"],"x-enumNames":["PRIMARY","SECONDARY"]}
InterfaceConfigButtonIcon
{"type":"object"}
| Property | Definition |
|---|---|
kind | {"allOf":[{"$ref":"InterfaceConfigButtonIconKind"}]} |
name | {"allOf":[{"$ref":"InterfaceConfigIcon"}]} |
url | {"type":"string"} |
tint | {"type":"boolean"} |
assetId | {"type":"string"} |
InterfaceConfigButtonIconKind
{"type":"string","enum":["builtin","asset"],"x-enumNames":["BUILTIN","ASSET"]}
InterfaceConfigButtonPhase
{"type":"string","enum":["start","ai","handoff","ended"],"x-enumNames":["START","AI","HANDOFF","ENDED"]}
InterfaceConfigButtonView
{"type":"string","enum":["chat","call"],"x-enumNames":["CHAT","CALL"]}
InterfaceConfigButtonWhen
{"type":"object"}
| Property | Definition |
|---|---|
views | {"type":"array","items":{"$ref":"InterfaceConfigButtonView"}} |
phases | {"type":"array","items":{"$ref":"InterfaceConfigButtonPhase"}} |
InterfaceConfigButtons
{"type":"object"}
| Property | Definition |
|---|---|
header | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
menu | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
composer | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
footer | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
handoff | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
handoff-end | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
conversation-end | {"type":"array","items":{"$ref":"InterfaceConfigButton"}} |
InterfaceConfigComposer
{"type":"object"}
| Property | Definition |
|---|---|
layout | {"allOf":[{"$ref":"InterfaceConfigComposerLayout"}]} |
dictation | {"type":"boolean"} |
attachments | {"allOf":[{"$ref":"InterfaceConfigComposerAttachments"}]} |
placeholder | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
shape | {"allOf":[{"$ref":"InterfaceConfigComposerShape"}]} |
sendButton | {"allOf":[{"$ref":"InterfaceConfigComposerSendButton"}]} |
maxLines | {"type":"integer","minimum":0,"maximum":9007199254740991} |
emptySize | {"allOf":[{"$ref":"InterfaceConfigComposerEmptySize"}]} |
InterfaceConfigComposerAttachments
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
maxFiles | {"type":"integer","minimum":0,"maximum":9007199254740991} |
InterfaceConfigComposerEmptySize
{"type":"string","enum":["compact","large"],"x-enumNames":["COMPACT","LARGE"]}
InterfaceConfigComposerLayout
{"type":"string","enum":["inline","two-tier"],"x-enumNames":["INLINE","TWO_TIER"]}
InterfaceConfigComposerSendButton
{"type":"object"}
| Property | Definition |
|---|---|
shape | {"allOf":[{"$ref":"InterfaceConfigComposerSendButtonShape"}]} |
icon | {"allOf":[{"$ref":"InterfaceConfigIcon"}]} |
InterfaceConfigComposerSendButtonShape
{"type":"string","enum":["circle","rounded","square"],"x-enumNames":["CIRCLE","ROUNDED","SQUARE"]}
InterfaceConfigComposerShape
{"type":"string","enum":["card","boxed","pill"],"x-enumNames":["CARD","BOXED","PILL"]}
InterfaceConfigConsent
{"type":"object"}
| Property | Definition |
|---|---|
chat | {"allOf":[{"$ref":"InterfaceConfigConsentChat"}]} |
InterfaceConfigConsentChat
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
title | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
text | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
acceptLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
declineLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
linkUrl | {"type":"string"} |
linkLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
revision | {"type":"string"} |
InterfaceConfigEnd
{"type":"object"}
| Property | Definition |
|---|---|
survey | {"allOf":[{"$ref":"InterfaceConfigEndSurvey"}]} |
InterfaceConfigEndSurvey
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
comment | {"type":"boolean"} |
InterfaceConfigFooter
{"type":"object"}
| Property | Definition |
|---|---|
note | {"type":"boolean"} |
noteText | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
poweredBy | {"type":"boolean"} |
InterfaceConfigHeader
{"type":"object"}
| Property | Definition |
|---|---|
layout | {"allOf":[{"$ref":"InterfaceConfigHeaderLayout"}]} |
appearance | {"allOf":[{"$ref":"InterfaceConfigHeaderAppearance"}]} |
buttonFill | {"allOf":[{"$ref":"InterfaceConfigHeaderButtonFill"}]} |
imageUrl | {"type":"string"} |
maxButtons | {"type":"integer","minimum":0,"maximum":9007199254740991} |
InterfaceConfigHeaderAppearance
{"type":"string","enum":["solid","fade"],"x-enumNames":["SOLID","FADE"]}
InterfaceConfigHeaderButtonFill
{"type":"string","enum":["plain","filled"],"x-enumNames":["PLAIN","FILLED"]}
InterfaceConfigHeaderLayout
{"type":"string","enum":["avatar-title","orb-title","title","logo","none"],"x-enumNames":["AVATAR_TITLE","ORB_TITLE","TITLE","LOGO","NONE"]}
InterfaceConfigHistory
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
persistence | {"allOf":[{"$ref":"InterfaceConfigHistoryPersistence"}]} |
allowDelete | {"type":"boolean"} |
listStyle | {"allOf":[{"$ref":"InterfaceConfigHistoryListStyle"}]} |
InterfaceConfigHistoryListStyle
{"type":"string","enum":["detailed","grouped"],"x-enumNames":["DETAILED","GROUPED"]}
InterfaceConfigHistoryPersistence
{"type":"string","enum":["memory","tab","browser"],"x-enumNames":["MEMORY","TAB","BROWSER"]}
InterfaceConfigIcon
{"type":"string","enum":["send","plus","stop","download","history","globe","menu","external-link","expand","minimize","close","phone","phone-end","chat","microphone","microphone-muted","speaker","speaker-muted","handoff","arrow-left","arrow-right","arrow-up","arrow-down","chevron-down","chevron-up","checkmark","copy","attachment","image","document","upload","warning","info","help","waveform","thumbs-up","thumbs-down","reset","settings","search","star","cart","gift","user","calendar","mail","home","link","package","briefcase"],"x-enumNames":["SEND","PLUS","STOP","DOWNLOAD","HISTORY","GLOBE","MENU","EXTERNAL_LINK","EXPAND","MINIMIZE","CLOSE","PHONE","PHONE_END","CHAT","MICROPHONE","MICROPHONE_MUTED","SPEAKER","SPEAKER_MUTED","HANDOFF","ARROW_LEFT","ARROW_RIGHT","ARROW_UP","ARROW_DOWN","CHEVRON_DOWN","CHEVRON_UP","CHECKMARK","COPY","ATTACHMENT","IMAGE","DOCUMENT","UPLOAD","WARNING","INFO","HELP","WAVEFORM","THUMBS_UP","THUMBS_DOWN","RESET","SETTINGS","SEARCH","STAR","CART","GIFT","USER","CALENDAR","MAIL","HOME","LINK","PACKAGE","BRIEFCASE"]}
InterfaceConfigLauncher
{"type":"object"}
| Property | Definition |
|---|---|
content | {"allOf":[{"$ref":"InterfaceConfigLauncherContent"}]} |
label | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
visual | {"allOf":[{"$ref":"InterfaceConfigLauncherVisual"}]} |
entry | {"allOf":[{"$ref":"InterfaceConfigLauncherEntry"}]} |
imageUrl | {"type":"string"} |
hidden | {"type":"boolean"} |
unreadBadge | {"type":"boolean"} |
callEntry | {"type":"boolean"} |
shape | {"allOf":[{"$ref":"InterfaceConfigLauncherShape"}]} |
size | {"type":"string"} |
openIcon | {"allOf":[{"$ref":"InterfaceConfigLauncherOpenIcon"}]} |
InterfaceConfigLauncherContent
{"type":"string","enum":["icon","label","icon-label"],"x-enumNames":["ICON","LABEL","ICON_LABEL"]}
InterfaceConfigLauncherEntry
{"type":"string","enum":["button","input","input-centred"],"x-enumNames":["BUTTON","INPUT","INPUT_CENTRED"]}
InterfaceConfigLauncherOpenIcon
{"type":"string","enum":["chevron","close","same"],"x-enumNames":["CHEVRON","CLOSE","SAME"]}
InterfaceConfigLauncherShape
{"type":"string","enum":["circle","rounded","pill"],"x-enumNames":["CIRCLE","ROUNDED","PILL"]}
InterfaceConfigLauncherVisual
{"type":"string","enum":["icon","image","orb"],"x-enumNames":["ICON","IMAGE","ORB"]}
InterfaceConfigLayout
{"type":"object"}
| Property | Definition |
|---|---|
mode | {"allOf":[{"$ref":"InterfaceConfigLayoutMode"}]} |
side | {"allOf":[{"$ref":"InterfaceConfigLayoutSide"}]} |
offset | {"allOf":[{"$ref":"InterfaceConfigLayoutOffset"}]} |
width | {"type":"string"} |
height | {"type":"string"} |
expandable | {"type":"boolean"} |
resizable | {"type":"boolean"} |
floating | {"allOf":[{"$ref":"InterfaceConfigLayoutFloating"}]} |
sidebar | {"allOf":[{"$ref":"InterfaceConfigLayoutSidebar"}]} |
sidebarInset | {"type":"string"} |
embedded | {"allOf":[{"$ref":"InterfaceConfigLayoutEmbedded"}]} |
zIndex | {"type":"integer","minimum":0,"maximum":9007199254740991} |
InterfaceConfigLayoutEmbedded
{"type":"object"}
| Property | Definition |
|---|---|
fill | {"allOf":[{"$ref":"InterfaceConfigLayoutEmbeddedFill"}]} |
InterfaceConfigLayoutEmbeddedFill
{"type":"string","enum":["container","window"],"x-enumNames":["CONTAINER","WINDOW"]}
InterfaceConfigLayoutFloating
{"type":"object"}
| Property | Definition |
|---|---|
anchor | {"allOf":[{"$ref":"InterfaceConfigLayoutFloatingAnchor"}]} |
backdrop | {"allOf":[{"$ref":"InterfaceConfigLayoutFloatingBackdrop"}]} |
coversLauncher | {"type":"boolean"} |
InterfaceConfigLayoutFloatingAnchor
{"type":"string","enum":["corner","center"],"x-enumNames":["CORNER","CENTER"]}
InterfaceConfigLayoutFloatingBackdrop / InterfaceConfigLayoutSidebarBackdrop
{"type":"string","enum":["none","dim","blur"],"x-enumNames":["NONE","DIM","BLUR"]}
InterfaceConfigLayoutMode
{"type":"string","enum":["floating","sidebar","embedded"],"x-enumNames":["FLOATING","SIDEBAR","EMBEDDED"]}
InterfaceConfigLayoutOffset
{"type":"object"}
| Property | Definition |
|---|---|
x | {"type":"string"} |
y | {"type":"string"} |
InterfaceConfigLayoutSide
{"type":"string","enum":["left","right"],"x-enumNames":["LEFT","RIGHT"]}
InterfaceConfigLayoutSidebar
{"type":"object"}
| Property | Definition |
|---|---|
behavior | {"allOf":[{"$ref":"InterfaceConfigLayoutSidebarBehavior"}]} |
style | {"allOf":[{"$ref":"InterfaceConfigLayoutSidebarStyle"}]} |
backdrop | {"allOf":[{"$ref":"InterfaceConfigLayoutSidebarBackdrop"}]} |
InterfaceConfigLayoutSidebarBehavior
{"type":"string","enum":["overlay","push"],"x-enumNames":["OVERLAY","PUSH"]}
InterfaceConfigLayoutSidebarStyle
{"type":"string","enum":["flush","inset"],"x-enumNames":["FLUSH","INSET"]}
InterfaceConfigLocale
{"type":"object"}
| Property | Definition |
|---|---|
default | {"type":"string"} |
enabled | {"type":"array","items":{"type":"string"}} |
strings | {"type":"array","items":{"$ref":"InterfaceConfigLocaleString"}} |
timeFormat | {"allOf":[{"$ref":"InterfaceConfigLocaleTimeFormat"}]} |
dateFormat | {"allOf":[{"$ref":"InterfaceConfigLocaleDateFormat"}]} |
InterfaceConfigLocaleDateFormat
{"type":"string","enum":["auto","short","long"],"x-enumNames":["AUTO","SHORT","LONG"]}
InterfaceConfigLocaleString
{"type":"object"}
| Property | Definition |
|---|---|
text | {"type":"string"} |
translations | {"type":"object","additionalProperties":{"type":"string"}} |
key · required | {"type":"string"} |
InterfaceConfigLocaleTimeFormat
{"type":"string","enum":["auto","12h","24h"],"x-enumNames":["AUTO","TWELVE_HOUR","TWENTY_FOUR_HOUR"]}
InterfaceConfigLocalizedText
{"type":"object"}
| Property | Definition |
|---|---|
text | {"type":"string"} |
translations | {"type":"object","additionalProperties":{"type":"string"}} |
InterfaceConfigMenu
{"type":"object"}
| Property | Definition |
|---|---|
presentation | {"allOf":[{"$ref":"InterfaceConfigMenuPresentation"}]} |
restartConfirmation | {"allOf":[{"$ref":"InterfaceConfigMenuRestartConfirmation"}]} |
InterfaceConfigMenuPresentation
{"type":"string","enum":["auto","sheet","popover","title","screen"],"x-enumNames":["AUTO","SHEET","POPOVER","TITLE","SCREEN"]}
InterfaceConfigMenuRestartConfirmation
{"type":"string","enum":["none","dialog","screen"],"x-enumNames":["NONE","DIALOG","SCREEN"]}
InterfaceConfigMessages
{"type":"object"}
| Property | Definition |
|---|---|
agentStyle | {"allOf":[{"$ref":"InterfaceConfigMessagesAgentStyle"}]} |
avatar | {"allOf":[{"$ref":"InterfaceConfigMessagesAvatar"}]} |
timestamps | {"type":"boolean"} |
aiDisclaimer | {"type":"boolean"} |
feedback | {"type":"boolean"} |
streaming | {"type":"boolean"} |
choiceStyle | {"allOf":[{"$ref":"InterfaceConfigMessagesChoiceStyle"}]} |
loader | {"allOf":[{"$ref":"InterfaceConfigMessagesLoader"}]} |
html | {"allOf":[{"$ref":"InterfaceConfigMessagesHtml"}]} |
linkHosts | {"type":"array","items":{"type":"string"}} |
scrollToBottom | {"type":"boolean"} |
avatarImageUrl | {"type":"string"} |
citations | {"allOf":[{"$ref":"InterfaceConfigMessagesCitations"}]} |
InterfaceConfigMessagesAgentStyle
{"type":"string","enum":["bubble","plain","card"],"x-enumNames":["BUBBLE","PLAIN","CARD"]}
InterfaceConfigMessagesAvatar
{"type":"string","enum":["none","every","last"],"x-enumNames":["NONE","EVERY","LAST"]}
InterfaceConfigMessagesChoiceStyle
{"type":"string","enum":["chips","outlined","links"],"x-enumNames":["CHIPS","OUTLINED","LINKS"]}
InterfaceConfigMessagesCitations
{"type":"string","enum":["none","list","sheet"],"x-enumNames":["NONE","LIST","SHEET"]}
InterfaceConfigMessagesHtml
{"type":"string","enum":["text","safe"],"x-enumNames":["TEXT","SAFE"]}
InterfaceConfigMessagesLoader
{"type":"string","enum":["dots","spinner-text","matrix","none"],"x-enumNames":["DOTS","SPINNER_TEXT","MATRIX","NONE"]}
InterfaceConfigSite
{"type":"object"}
| Property | Definition |
|---|---|
url | {"type":"string"} |
InterfaceConfigSounds
{"type":"object"}
| Property | Definition |
|---|---|
chime | {"type":"boolean"} |
InterfaceConfigStart
{"type":"object"}
| Property | Definition |
|---|---|
firstTurn | {"allOf":[{"$ref":"InterfaceConfigStartFirstTurn"}]} |
welcomeBanner | {"allOf":[{"$ref":"InterfaceConfigStartWelcomeBanner"}]} |
homeScreen | {"type":"boolean"} |
starters | {"type":"array","items":{"$ref":"InterfaceConfigStartStarter"}} |
starterDisplay | {"allOf":[{"$ref":"InterfaceConfigStartStarterDisplay"}]} |
teaser | {"allOf":[{"$ref":"InterfaceConfigStartTeaser"}]} |
autoOpen | {"type":"boolean"} |
headline | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigStartFirstTurn
{"type":"string","enum":["agent","user"],"x-enumNames":["AGENT","USER"]}
InterfaceConfigStartStarter
{"type":"object"}
| Property | Definition |
|---|---|
text | {"type":"string"} |
translations | {"type":"object","additionalProperties":{"type":"string"}} |
id · required | {"type":"string","pattern":"^[a-z][a-z0-9-]*$"} |
icon | {"allOf":[{"$ref":"InterfaceConfigIcon"}]} |
description | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigStartStarterDisplay
{"type":"string","enum":["chips","cards","links"],"x-enumNames":["CHIPS","CARDS","LINKS"]}
InterfaceConfigStartWelcomeBanner
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
imageUrl | {"type":"string"} |
description | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigTheme
{"type":"object"}
| Property | Definition |
|---|---|
mode | {"allOf":[{"$ref":"InterfaceConfigThemeMode"}]} |
glass | {"allOf":[{"$ref":"InterfaceConfigThemeGlass"}]} |
tokens | {"allOf":[{"$ref":"InterfaceConfigThemeTokens"}]} |
dark | {"allOf":[{"$ref":"InterfaceConfigThemeDark"}]} |
fontUrl | {"type":"string"} |
background | {"allOf":[{"$ref":"InterfaceConfigThemeBackground"}]} |
InterfaceConfigThemeBackground
{"type":"object"}
| Property | Definition |
|---|---|
imageUrl | {"type":"string"} |
fit | {"allOf":[{"$ref":"InterfaceConfigThemeBackgroundFit"}]} |
opacity | {"type":"number","minimum":0,"maximum":1} |
scope | {"allOf":[{"$ref":"InterfaceConfigThemeBackgroundScope"}]} |
InterfaceConfigThemeBackgroundFit
{"type":"string","enum":["cover","contain","tile"],"x-enumNames":["COVER","CONTAIN","TILE"]}
InterfaceConfigThemeBackgroundScope
{"type":"string","enum":["panel","home"],"x-enumNames":["PANEL","HOME"]}
InterfaceConfigThemeColors
{"type":"object"}
| Property | Definition |
|---|---|
brand | {"type":"string"} |
surface | {"type":"string"} |
text | {"type":"string"} |
textMuted | {"type":"string"} |
border | {"type":"string"} |
link | {"type":"string"} |
focus | {"type":"string"} |
headerBg | {"type":"string"} |
headerText | {"type":"string"} |
launcherBg | {"type":"string"} |
launcherIcon | {"type":"string"} |
userBubble | {"type":"string"} |
userText | {"type":"string"} |
agentBubble | {"type":"string"} |
agentText | {"type":"string"} |
error | {"type":"string"} |
success | {"type":"string"} |
warning | {"type":"string"} |
InterfaceConfigThemeDark
{"type":"object"}
| Property | Definition |
|---|---|
color | {"allOf":[{"$ref":"InterfaceConfigThemeColors"}]} |
InterfaceConfigThemeFont
{"type":"object"}
| Property | Definition |
|---|---|
family | {"type":"string"} |
sizeBase | {"type":"string"} |
baselineOffset | {"type":"string"} |
InterfaceConfigThemeGlass
{"type":"string","enum":["none","frosted","clear","sheer"],"x-enumNames":["NONE","FROSTED","CLEAR","SHEER"]}
InterfaceConfigThemeMode
{"type":"string","enum":["light","dark","system"],"x-enumNames":["LIGHT","DARK","SYSTEM"]}
InterfaceConfigThemeMotion / InterfaceConfigThemeSpace
{"type":"object"}
| Property | Definition |
|---|---|
scale | {"type":"string"} |
InterfaceConfigThemeRadius / InterfaceConfigThemeShadow
{"type":"object"}
| Property | Definition |
|---|---|
panel | {"type":"string"} |
InterfaceConfigThemeSize
{"type":"object"}
| Property | Definition |
|---|---|
messageMaxWidth | {"type":"string"} |
InterfaceConfigThemeTokenColors
{"type":"object"}
| Property | Definition |
|---|---|
brand | {"type":"string"} |
surface | {"type":"string"} |
text | {"type":"string"} |
textMuted | {"type":"string"} |
border | {"type":"string"} |
link | {"type":"string"} |
focus | {"type":"string"} |
headerBg | {"type":"string"} |
headerText | {"type":"string"} |
launcherBg | {"type":"string"} |
launcherIcon | {"type":"string"} |
userBubble | {"type":"string"} |
userText | {"type":"string"} |
agentBubble | {"type":"string"} |
agentText | {"type":"string"} |
error | {"type":"string"} |
success | {"type":"string"} |
warning | {"type":"string"} |
brandGradient | {"type":"string"} |
sendButton | {"type":"string"} |
InterfaceConfigThemeTokens
{"type":"object"}
| Property | Definition |
|---|---|
color | {"allOf":[{"$ref":"InterfaceConfigThemeTokenColors"}]} |
font | {"allOf":[{"$ref":"InterfaceConfigThemeFont"}]} |
radius | {"allOf":[{"$ref":"InterfaceConfigThemeRadius"}]} |
space | {"allOf":[{"$ref":"InterfaceConfigThemeSpace"}]} |
shadow | {"allOf":[{"$ref":"InterfaceConfigThemeShadow"}]} |
motion | {"allOf":[{"$ref":"InterfaceConfigThemeMotion"}]} |
size | {"allOf":[{"$ref":"InterfaceConfigThemeSize"}]} |
InterfaceConfigTranscript
{"type":"object"}
| Property | Definition |
|---|---|
download | {"type":"boolean"} |
InterfaceConfigVoice
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
callToAction | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
orb | {"allOf":[{"$ref":"InterfaceConfigVoiceOrb"}]} |
status | {"allOf":[{"$ref":"InterfaceConfigVoiceStatus"}]} |
interrupt | {"allOf":[{"$ref":"InterfaceConfigVoiceInterrupt"}]} |
microphoneDenied | {"allOf":[{"$ref":"InterfaceConfigVoiceMicrophoneDenied"}]} |
connectionError | {"allOf":[{"$ref":"InterfaceConfigVoiceConnectionError"}]} |
InterfaceConfigVoiceConnectionError
{"type":"object"}
| Property | Definition |
|---|---|
title | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
text | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
retryLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigVoiceInterrupt
{"type":"object"}
| Property | Definition |
|---|---|
enabled | {"type":"boolean"} |
label | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigVoiceMicrophoneDenied
{"type":"object"}
| Property | Definition |
|---|---|
title | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
text | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
retryLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
continueInChatLabel | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
InterfaceConfigVoiceOrb
{"type":"object"}
| Property | Definition |
|---|---|
preset | {"type":"string"} |
colors | {"type":"array","items":{"type":"string"}} |
imageUrl | {"type":"string"} |
InterfaceConfigVoiceStatus
{"type":"object"}
| Property | Definition |
|---|---|
connecting | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
listening | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
thinking | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
speaking | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
reconnecting | {"allOf":[{"$ref":"InterfaceConfigLocalizedText"}]} |
JsonSchema
{"type":"object","additionalProperties":{}}
KBDocumentCSVData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["csv"],"x-enumNames":["CSV"]} |
name · required | {"type":"string"} |
rowsCount | {"type":"number"} |
url | {"nullable":true,"type":"string"} |
KBDocumentChunk
{"type":"object"}
| Property | Definition |
|---|---|
chunkID · required | {"type":"string"} |
content · required | {"type":"string"} |
metadata | {"type":"object","additionalProperties":{}} |
KBDocumentChunkSmartChunking
{"type":"object"}
| Property | Definition |
|---|---|
markdownConversion | {"type":"boolean"} |
llmBasedChunks | {"type":"boolean"} |
llmGeneratedQ | {"type":"boolean"} |
llmContentSummarization | {"type":"boolean"} |
llmPrependContext | {"type":"boolean"} |
singleChunk | {"type":"boolean"} |
KBDocumentData
{"oneOf":[{"$ref":"KBDocumentUrlData"},{"$ref":"KBDocumentDocxData"},{"$ref":"KBDocumentPDFData"},{"$ref":"KBDocumentTextData"},{"$ref":"KBDocumentMarkdownData"},{"$ref":"KBDocumentCSVData"},{"$ref":"KBDocumentXLSXData"},{"$ref":"KBDocumentTableData"},{"$ref":"KBDocumentSitemapData"},{"$ref":"KBDocumentIntegrationData"}]}
KBDocumentDocxData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["docx"],"x-enumNames":["DOCX"]} |
name · required | {"type":"string"} |
url | {"nullable":true,"type":"string"} |
KBDocumentIntegrationConfig
{"type":"object"}
| Property | Definition |
|---|---|
filters · required | {"type":"object","additionalProperties":{}} |
preserveStructure · required | {"type":"boolean"} |
importMetadata · required | {"type":"boolean"} |
connection · required | {"type":"object","properties":{"fingerprint":{"type":"string"}},"required":["fingerprint"]} |
exclude · required | {"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"}},"required":["key","name"]}} |
KBDocumentIntegrationData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["integration"],"x-enumNames":["INTEGRATION"]} |
name · required | {"type":"string"} |
source · required | {"$ref":"KnowledgeBaseDocumentIntegrationType"} |
config · required | {"$ref":"KBDocumentIntegrationConfig"} |
refreshRate | {"allOf":[{"$ref":"KnowledgeBaseDocumentRefreshRate"}]} |
lastSuccessUpdate | {"type":"string"} |
sync | {"nullable":true,"allOf":[{"$ref":"KBDocumentSitemapSync"}]} |
KBDocumentMarkdownData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["md"],"x-enumNames":["MD"]} |
name · required | {"type":"string"} |
url | {"nullable":true,"type":"string"} |
KBDocumentMetadataM2MBackup
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
metadataFieldID · required | {"type":"string"} |
documentID · required | {"type":"string"} |
versionID · required | {"type":"string"} |
KBDocumentPDFData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["pdf"],"x-enumNames":["PDF"]} |
name · required | {"type":"string"} |
url | {"nullable":true,"type":"string"} |
KBDocumentSitemapData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["sitemap"],"x-enumNames":["SITEMAP"]} |
name · required | {"type":"string"} |
url · required | {"type":"string"} |
refreshRate | {"allOf":[{"$ref":"KnowledgeBaseDocumentRefreshRate"}]} |
refreshTime | {"nullable":true,"type":"string","pattern":"^([01]\\d|2[0-3]):(00|30)$"} |
refreshTimezone | {"nullable":true,"type":"string"} |
lastSuccessUpdate | {"type":"string"} |
lastRefreshScheduledFor | {"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
patterns | {"allOf":[{"$ref":"KBDocumentSitemapPatterns"}]} |
sync | {"nullable":true,"allOf":[{"$ref":"KBDocumentSitemapSync"}]} |
KBDocumentSitemapPatterns
{"type":"object"}
| Property | Definition |
|---|---|
include · required | {"type":"array","items":{"type":"string"}} |
exclude · required | {"type":"array","items":{"type":"string"}} |
KBDocumentSitemapSync
{"type":"object"}
| Property | Definition |
|---|---|
syncedAt · required | {"type":"string"} |
startedAt | {"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
addedCount · required | {"type":"number"} |
removedCount · required | {"type":"number"} |
failure | {"nullable":true,"type":"object","properties":{"message":{"type":"string"},"at":{"type":"string"},"code":{"allOf":[{"$ref":"KBDocumentSitemapSyncFailureCode"}]}},"required":["message","at"]} |
KBDocumentSitemapSyncFailureCode
{"type":"string","enum":["documentLimit","integrationDisconnected","integrationUnauthorized","integrationAccountChanged","rateLimited"],"x-enumNames":["DOCUMENT_LIMIT","INTEGRATION_DISCONNECTED","INTEGRATION_UNAUTHORIZED","INTEGRATION_ACCOUNT_CHANGED","RATE_LIMITED"]}
KBDocumentStatus
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"KnowledgeBaseDocumentStatus"} |
data | {} |
KBDocumentTableData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["table"],"x-enumNames":["TABLE"]} |
name · required | {"type":"string"} |
rowsCount · required | {"type":"number"} |
url | {"nullable":true,"type":"string"} |
KBDocumentTextData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
name · required | {"type":"string"} |
canEdit | {"type":"boolean"} |
url | {"nullable":true,"type":"string"} |
KBDocumentUrlData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["url"],"x-enumNames":["URL"]} |
name · required | {"type":"string"} |
url · required | {"type":"string"} |
title | {"type":"string"} |
refreshRate | {"allOf":[{"$ref":"KnowledgeBaseDocumentRefreshRate"}]} |
refreshTime | {"nullable":true,"type":"string","pattern":"^([01]\\d|2[0-3]):(00|30)$"} |
refreshTimezone | {"nullable":true,"type":"string"} |
lastSuccessUpdate | {"type":"string"} |
lastRefreshScheduledFor | {"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
contentChangedAt | {"type":"string"} |
accessTokenID | {"type":"number"} |
integrationExternalID | {"type":"string"} |
source | {"allOf":[{"$ref":"KnowledgeBaseDocumentIntegrationType"}]} |
sitemapDocumentID | {"nullable":true,"type":"string"} |
integrationDocumentID | {"nullable":true,"type":"string"} |
integrationPath | {"nullable":true,"type":"array","items":{"type":"string"}} |
KBDocumentVersionBackup
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
documentID · required | {"type":"string"} |
versionID · required | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
KBDocumentXLSXData
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["xlsx"],"x-enumNames":["XLSX"]} |
name · required | {"type":"string"} |
rowsCount | {"type":"number"} |
url | {"nullable":true,"type":"string"} |
KBSettingsBackup
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
versionID · required | {"type":"string"} |
summarization · required | {"nullable":true,"allOf":[{"$ref":"KnowledgeBaseSummarization"}]} |
chunkStrategy · required | {"nullable":true,"allOf":[{"$ref":"KnowledgeBaseChunkStrategy"}]} |
search · required | {"nullable":true,"allOf":[{"$ref":"KnowledgeBaseSearch"}]} |
embeddingModel | {"nullable":true,"allOf":[{"$ref":"KnowledgeBaseEmbeddingModel"}]} |
KBSettingsChunkStrategy
{"type":"string","enum":["recursive_text_splitter"],"x-enumNames":["RECURSIVE_TEXT_SPLITTER"]}
KBSettingsPromptMode
{"type":"string","enum":["prompt","memory","memory_prompt"],"x-enumNames":["PROMPT","MEMORY","MEMORY_PROMPT"]}
KnowledgeBaseChunkStrategy
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"KBSettingsChunkStrategy"} |
size · required | {"type":"number"} |
overlap · required | {"type":"number"} |
KnowledgeBaseDocument
{"type":"object"}
| Property | Definition |
|---|---|
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
createdAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
creatorID · required | {"type":"number"} |
documentID · required | {"type":"string"} |
s3ObjectRef | {"type":"string"} |
version | {"type":"number"} |
status · required | {"$ref":"KBDocumentStatus"} |
folderID | {"nullable":true,"type":"string"} |
data · required | {"nullable":true,"allOf":[{"$ref":"KBDocumentData"}]} |
chunks | {"type":"array","items":{"$ref":"KBDocumentChunk"}} |
smartChunking | {"nullable":true,"allOf":[{"$ref":"KBDocumentChunkSmartChunking"}]} |
metadata | {"type":"array","items":{"$ref":"DocumentMetadataEntry"}} |
KnowledgeBaseDocumentIntegrationType
{"type":"string","enum":["zendesk","shopify","kustomer"],"x-enumNames":["ZENDESK","SHOPIFY","KUSTOMER"]}
KnowledgeBaseDocumentRefreshRate
{"type":"string","enum":["daily","weekly","monthly","never"],"x-enumNames":["DAILY","WEEKLY","MONTHLY","NEVER"]}
KnowledgeBaseDocumentStatus
{"type":"string","enum":["ERROR","PENDING","SUCCESS","INITIALIZED"],"x-enumNames":["ERROR","PENDING","SUCCESS","INITIALIZED"]}
KnowledgeBaseEmbeddingModel
{"type":"object"}
| Property | Definition |
|---|---|
model · required | {"type":"string"} |
size · required | {"type":"number"} |
KnowledgeBaseSearch
{"type":"object"}
| Property | Definition |
|---|---|
limit · required | {"type":"number"} |
metric · required | {"type":"string"} |
KnowledgeBaseSettings
{"type":"object"}
| Property | Definition |
|---|---|
summarization · required | {"$ref":"KnowledgeBaseSummarization"} |
chunkStrategy · required | {"$ref":"KnowledgeBaseChunkStrategy"} |
search · required | {"$ref":"KnowledgeBaseSearch"} |
embeddingModel | {"allOf":[{"$ref":"KnowledgeBaseEmbeddingModel"}]} |
KnowledgeBaseSummarization
{"type":"object"}
| Property | Definition |
|---|---|
model | {"allOf":[{"$ref":"AIModel"}]} |
system | {"type":"string"} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
mode · required | {"$ref":"KBSettingsPromptMode"} |
prompt · required | {"type":"string"} |
LLMFallbackSettings
{"type":"object"}
| Property | Definition |
|---|---|
models · required | {"$ref":"FallbackMapping"} |
Language
{"type":"string","enum":["en-us"],"x-enumNames":["ENGLISH_US"]}
Legacy13_ProjectEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
alias · required | {"type":"string"} |
isMain · required | {"type":"boolean"} |
releases · required | {"type":"array","items":{"$ref":"Legacy13_ProjectEnvironmentRelease"}} |
createdAt · required | {"type":"string"} |
draftVersionID · required | {"type":"string"} |
createdByUserID · required | {"type":"number"} |
clonedFromMainAt | {"type":"string","nullable":true} |
trafficPercentage · required | {"type":"number","maximum":100,"minimum":0} |
nextReleaseNumber · required | {"type":"number"} |
publishedVersionID · required | {"type":"string"} |
draftVersionIDsHistory · required | {"type":"array","items":{"type":"string"}} |
Legacy13_ProjectEnvironmentListResponse
{"type":"object"}
| Property | Definition |
|---|---|
data · required | {"type":"array","items":{"$ref":"Legacy13_ProjectEnvironment"}} |
Legacy13_ProjectEnvironmentRelease / Legacy14_ProjectEnvironmentRelease / Legacy15_ProjectEnvironmentRelease / Legacy16_ProjectEnvironmentRelease
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
backupID · required | {"type":"number"} |
createdAt · required | {"type":"string"} |
versionID · required | {"type":"string"} |
description · required | {"type":"string","nullable":true} |
autogenerated · required | {"type":"boolean"} |
createdByUserID · required | {"type":"number","nullable":true} |
Legacy14_ProjectEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
alias · required | {"type":"string"} |
isMain · required | {"type":"boolean"} |
releases · required | {"type":"array","items":{"$ref":"Legacy14_ProjectEnvironmentRelease"}} |
createdAt · required | {"type":"string"} |
draftVersionID · required | {"type":"string"} |
createdByUserID · required | {"type":"number"} |
clonedFromMainAt | {"type":"string","nullable":true} |
trafficPercentage · required | {"type":"number","maximum":100,"minimum":0} |
nextReleaseNumber · required | {"type":"number"} |
publishedVersionID · required | {"type":"string"} |
draftVersionIDsHistory · required | {"type":"array","items":{"type":"string"}} |
Legacy14_ProjectEnvironmentResponse
{"type":"object"}
| Property | Definition |
|---|---|
data · required | {"$ref":"Legacy14_ProjectEnvironment"} |
Legacy15_CreateProjectEnvironmentApiPublicRequest
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string","minLength":1} |
alias | {"type":"string","minLength":1} |
cloneFromEnvironmentID | {"type":"string","minLength":1} |
Legacy15_ProjectEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
alias · required | {"type":"string"} |
isMain · required | {"type":"boolean"} |
releases · required | {"type":"array","items":{"$ref":"Legacy15_ProjectEnvironmentRelease"}} |
createdAt · required | {"type":"string"} |
draftVersionID · required | {"type":"string"} |
createdByUserID · required | {"type":"number"} |
clonedFromMainAt | {"type":"string","nullable":true} |
trafficPercentage · required | {"type":"number","maximum":100,"minimum":0} |
nextReleaseNumber · required | {"type":"number"} |
publishedVersionID · required | {"type":"string"} |
draftVersionIDsHistory · required | {"type":"array","items":{"type":"string"}} |
Legacy15_ProjectEnvironmentResponse
{"type":"object"}
| Property | Definition |
|---|---|
data · required | {"$ref":"Legacy15_ProjectEnvironment"} |
Legacy16_ProjectEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
alias · required | {"type":"string"} |
isMain · required | {"type":"boolean"} |
releases · required | {"type":"array","items":{"$ref":"Legacy16_ProjectEnvironmentRelease"}} |
createdAt · required | {"type":"string"} |
draftVersionID · required | {"type":"string"} |
createdByUserID · required | {"type":"number"} |
clonedFromMainAt | {"type":"string","nullable":true} |
trafficPercentage · required | {"type":"number","maximum":100,"minimum":0} |
nextReleaseNumber · required | {"type":"number"} |
publishedVersionID · required | {"type":"string"} |
draftVersionIDsHistory · required | {"type":"array","items":{"type":"string"}} |
Legacy16_ProjectEnvironmentPublishResponse
{"type":"object"}
| Property | Definition |
|---|---|
data · required | {"type":"object","properties":{"projectEnvironment":{"$ref":"Legacy16_ProjectEnvironment"},"projectEnvironmentRelease":{"$ref":"Legacy16_ProjectEnvironmentRelease"}},"required":["projectEnvironment","projectEnvironmentRelease"]} |
Legacy16_PublishProjectEnvironmentRequest
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string","minLength":1} |
description · required | {"type":"string","nullable":true} |
Legacy17_ProjectEnvironmentTrafficResponse
{"type":"object"}
| Property | Definition |
|---|---|
data · required | {"type":"object","additionalProperties":{"type":"number","minimum":0,"maximum":100}} |
Legacy17_SplitTrafficProjectEnvironmentRequest
{"type":"object","additionalProperties":{"type":"number","minimum":0,"maximum":100}}
LegacyCanvasNodeVisibility
{"type":"string","enum":["preview","all-variants"],"x-enumNames":["PREVIEW","ALL_VARIANTS"]}
MarkdownLikeString
Message text shown to the end user. Limited markdown: bold, _italic_, <u>underline</u>, ~~strikethrough~~, [label](url). {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
{"type":"string"}
Markup
{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"MarkupSpan"},{"$ref":"MarkupToolReference"},{"$ref":"MarkupSecretReference"},{"$ref":"MarkupEntityReference"},{"$ref":"MarkupVariableReference"}]}}
MarkupEntityReference / UtteranceTextEntityReference
{"type":"object"}
| Property | Definition |
|---|---|
entityID · required | {"type":"string"} |
MarkupSecretReference
{"type":"object"}
| Property | Definition |
|---|---|
secretID · required | {"type":"string"} |
MarkupSpan
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"$ref":"Markup"} |
attributes | {"type":"object","additionalProperties":{}} |
MarkupToolReference
{"type":"object"}
| Property | Definition |
|---|---|
resourceID · required | {"type":"string"} |
referenceType · required | {"$ref":"MarkupToolReferenceType"} |
MarkupToolReferenceType
{"type":"string","enum":["function","api-call","integration","mcp-integration","flow","agent","path-tool","system-tool"],"x-enumNames":["FUNCTION","API_CALL","INTEGRATION","MCP_INTEGRATION","FLOW","AGENT","PATH_TOOL","SYSTEM_TOOL"]}
MarkupVariableReference
{"type":"object"}
| Property | Definition |
|---|---|
variableID · required | {"type":"string"} |
path | {"type":"string"} |
McpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
description · required | {"nullable":true,"type":"string"} |
mcpServerToolID · required | {"type":"string"} |
McpIntegrationToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["mcp-integration"],"x-enumNames":["MCP_INTEGRATION"]} |
toolID · required | {"type":"string"} |
McpServerAuthType
{"type":"string","enum":["custom","oauth"],"x-enumNames":["CUSTOM","OAUTH"]}
McpServerOAuthMetadata
{"type":"object"}
| Property | Definition |
|---|---|
connected · required | {"type":"boolean"} |
expiresAt | {"nullable":true,"type":"string"} |
scope | {"nullable":true,"type":"string"} |
authServerUrl | {"nullable":true,"type":"string"} |
McpServerSpecification
{"type":"string","enum":["2025-03-26","2025-06-18"],"x-enumNames":["V_2025_03_26","V_2025_06_18"]}
McpServerTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
toolName · required | {"type":"string"} |
description | {"nullable":true,"type":"string"} |
inputSchema · required | {"$ref":"JsonSchema"} |
mcpServerID · required | {"type":"string"} |
MediaAttachment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["media"],"x-enumNames":["MEDIA"]} |
url · required | {"$ref":"Markup"} |
name · required | {"type":"string","maxLength":255} |
isAsset · required | {"type":"boolean"} |
datatype · required | {"$ref":"MediaDatatype"} |
MediaDatatype
{"type":"string","enum":["image","video"],"x-enumNames":["IMAGE","VIDEO"]}
MicrosoftVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["microsoft"],"x-enumNames":["MICROSOFT"]} |
voice · required | {"type":"string"} |
NativeToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["native"],"x-enumNames":["NATIVE"]} |
kind · required | {"$ref":"SimulationTurnTestToolNativeKind"} |
OnJumpProgramCommand
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["jump"],"x-enumNames":["JUMP"]} |
nextID · required | {"nullable":true,"type":"string"} |
platform | {"type":"string"} |
diagramID | {"nullable":true,"type":"string"} |
on · required | {"type":"object","additionalProperties":{}} |
OnPushProgramCommand
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["push"],"x-enumNames":["PUSH"]} |
platform | {"type":"string"} |
diagramID | {"nullable":true,"type":"string"} |
on · required | {"type":"object","additionalProperties":{}} |
Persona
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
items · required | {"type":"array","items":{"$ref":"PersonaItem"}} |
PersonaItem
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
variableID · required | {"nullable":true,"type":"string"} |
value · required | {"nullable":true,"type":"string"} |
Program
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
name | {"type":"string"} |
lines · required | {"type":"object","additionalProperties":{"$ref":"ProgramLine"}} |
startId · required | {"type":"string"} |
legacyID | {"type":"string"} |
commands · required | {"type":"array","items":{"$ref":"AnyProgramCommand"}} |
diagramID · required | {"type":"string"} |
versionID · required | {"type":"string"} |
variables · required | {"type":"array","items":{"type":"string"}} |
updatedAt | {} |
ProgramLine
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
type · required | {"type":"string"} |
Project
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
nlu | {"type":"string"} |
type | {"type":"string"} |
name · required | {"type":"string"} |
image | {"type":"string"} |
teamID · required | {"type":"string"} |
members · required | {"type":"array","items":{"$ref":"ProjectMember"}} |
privacy | {"allOf":[{"$ref":"ProjectPrivacy"}]} |
platform · required | {"type":"string"} |
_version | {"type":"number"} |
linkType | {"type":"string"} |
stickers | {"type":"array","items":{"$ref":"ProjectSticker"}} |
creatorID · required | {"type":"number"} |
updatedBy | {"type":"number"} |
createdAt | {"nullable":true,"type":"string"} |
updatedAt | {"type":"string"} |
prototype | {"allOf":[{"$ref":"ProjectPrototype"}]} |
apiPrivacy | {"allOf":[{"$ref":"ProjectPrivacy"}]} |
reportTags | {"type":"object","additionalProperties":{"$ref":"ProjectReportTag"}} |
nluSettings | {"allOf":[{"$ref":"ProjectNLUSettings"}]} |
environments | {"type":"object","additionalProperties":{"$ref":"ProjectEnvironment"}} |
platformData · required | {"type":"object","additionalProperties":{}} |
customThemes | {"type":"array","items":{"$ref":"ProjectCustomTheme"}} |
aiAssistSettings | {"allOf":[{"$ref":"ProjectAIAssistSettings"}]} |
transcriptSettings | {"allOf":[{"$ref":"ProjectTranscriptSettings"}]} |
analyticsSettings | {"allOf":[{"$ref":"ProjectAnalyticsSettings"}]} |
objective | {"allOf":[{"$ref":"ProjectObjective"}]} |
devVersion | @deprecated use environments instead with environments projects {"type":"string"} |
liveVersion | @deprecated use environments instead with environments projects {"type":"string"} |
stagingVersion | @deprecated use environments instead with environments projects {"type":"string"} |
previewVersion | @deprecated won't be used anymore with environments projects {"type":"string"} |
knowledgeBase | @deprecated not used anymore {"allOf":[{"$ref":"VersionKnowledgeBase"}]} |
ProjectAIAssistSettings
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
aiPlayground | {"type":"boolean"} |
generateStep | {"type":"boolean"} |
generativeTasks | {"type":"boolean"} |
generateNoMatch | {"type":"boolean"} |
ProjectAnalyticsSettings
{"type":"object"}
| Property | Definition |
|---|---|
topics | {"type":"object","properties":{"enabled":{"type":"boolean"},"enabledAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["enabled","enabledAt"]} |
ProjectCustomTheme
{"type":"object"}
| Property | Definition |
|---|---|
name | {"type":"string"} |
palette · required | {"$ref":"ProjectCustomThemePalette"} |
standardColor · required | {"type":"string"} |
ProjectCustomThemePalette / WidgetSettingsColorPalette
{"type":"object"}
| Property | Definition |
|---|---|
50 · required | {"type":"string"} |
100 · required | {"type":"string"} |
200 · required | {"type":"string"} |
300 · required | {"type":"string"} |
400 · required | {"type":"string"} |
500 · required | {"type":"string"} |
600 · required | {"type":"string"} |
700 · required | {"type":"string"} |
800 · required | {"type":"string"} |
900 · required | {"type":"string"} |
ProjectEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
alias · required | {"type":"string"} |
isMain · required | {"type":"boolean"} |
releases · required | {"type":"array","items":{"$ref":"ProjectEnvironmentRelease"}} |
createdAt · required | {"type":"string"} |
draftVersionID · required | {"type":"string"} |
createdByUserID · required | {"type":"number"} |
clonedFromMainAt | {"nullable":true,"type":"string"} |
pullBase | {"nullable":true,"allOf":[{"$ref":"ProjectEnvironmentPullBase"}]} |
pullStatus | {"nullable":true,"allOf":[{"$ref":"ProjectEnvironmentPullStatus"}]} |
trafficPercentage · required | {"type":"number","minimum":0,"maximum":100} |
nextReleaseNumber · required | {"type":"number"} |
publishedVersionID · required | {"type":"string"} |
draftVersionIDsHistory · required | {"type":"array","items":{"type":"string"}} |
protected | {"type":"boolean"} |
ProjectEnvironmentPullBase
{"type":"object"}
| Property | Definition |
|---|---|
backupID · required | {"type":"number"} |
versionID · required | {"type":"string"} |
sourceName · required | {"type":"string"} |
createdAt · required | {"type":"string"} |
ProjectEnvironmentPullConflict
{"type":"object"}
| Property | Definition |
|---|---|
collection · required | {"type":"string"} |
id · required | {"type":"string"} |
name · required | {"nullable":true,"type":"string"} |
ProjectEnvironmentPullStatus
{"type":"object"}
| Property | Definition |
|---|---|
status · required | {"type":"string","enum":["running","succeeded","failed"],"x-enumNames":["RUNNING","SUCCEEDED","FAILED"]} |
actionID · required | {"type":"string"} |
error · required | {"nullable":true,"type":"string"} |
startedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
finishedAt · required | {"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
startedByUserID · required | {"type":"number"} |
sourceBackupID · required | {"nullable":true,"type":"number"} |
sourceVersionID · required | {"type":"string"} |
sourceName · required | {"type":"string"} |
draftVersionID · required | {"nullable":true,"type":"string"} |
summary · required | {"nullable":true,"allOf":[{"$ref":"ProjectEnvironmentPullSummary"}]} |
conflicts · required | {"type":"array","items":{"$ref":"ProjectEnvironmentPullConflict"}} |
ProjectEnvironmentPullSummary
{"type":"object"}
| Property | Definition |
|---|---|
added · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
overwritten · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
deleted · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
conflicted · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
retained · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
dropped · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
renamed · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
ProjectEnvironmentRelease
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
backupID · required | {"type":"number"} |
createdAt · required | {"type":"string"} |
versionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
autogenerated · required | {"type":"boolean"} |
createdByUserID · required | {"nullable":true,"type":"number"} |
pullBase | {"nullable":true,"allOf":[{"$ref":"ProjectEnvironmentPullBase"}]} |
ProjectFramework
{"type":"string","enum":["agentic","conversation"],"x-enumNames":["AGENTIC","CONVERSATION"]}
ProjectMember
{"type":"object"}
| Property | Definition |
|---|---|
creatorID · required | {"type":"number"} |
platformData · required | {"type":"object","additionalProperties":{}} |
ProjectNLUSettings
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
classifyStrategy | {"type":"string"} |
ProjectObjective
{"type":"string","enum":["resolution","deflection","customer-satisfaction","conversion"],"x-enumNames":["RESOLUTION","DEFLECTION","CUSTOMER_SATISFACTION","CONVERSION"]}
ProjectPrivacy
{"type":"string","enum":["public","private"],"x-enumNames":["PUBLIC","PRIVATE"]}
ProjectPrototype
{"type":"object"}
| Property | Definition |
|---|---|
nlp · required | {"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["LUIS"],"x-enumNames":["LUIS"]},"appID":{"type":"string"},"resourceID":{"type":"string"}},"required":["type","appID"]},{"type":"object","properties":{"type":{"type":"string","enum":["VFNLU"],"x-enumNames":["VFNLU"]}},"required":["type"]}]} |
data · required | {} |
trainedModel | {"allOf":[{"$ref":"PrototypeModel"}]} |
lastTrainedTime | {"type":"number"} |
ProjectReportTag
{"type":"object"}
| Property | Definition |
|---|---|
label · required | {"type":"string"} |
tagID · required | {"type":"string"} |
ProjectSticker
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
url · required | {"type":"string"} |
ProjectTranscriptSettings
{"type":"object"}
| Property | Definition |
|---|---|
inactiveTimeout | {"default":10,"type":"number","minimum":10,"maximum":60} |
saveTestTranscripts · required | {"type":"boolean"} |
saveTranscriptsWithNoInteraction | {"default":true,"type":"boolean"} |
Prompt
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
draft | {"default":null,"nullable":true,"type":"boolean"} |
settings · required | {"$ref":"PromptSettings"} |
description · required | {"nullable":true,"type":"string"} |
messageOrder · required | {"type":"array","items":{"type":"string"}} |
PromptCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["prompt"],"x-enumNames":["PROMPT"]} |
matchAll · required | {"type":"boolean"} |
promptID | {"type":"string"} |
assertions · required | {"type":"array","items":{"$ref":"ConditionPromptAssertion"}} |
PromptConditionAssertionLhs
{"type":"object"}
| Property | Definition |
|---|---|
path | {"type":"string"} |
PromptMessage
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
type · required | {"$ref":"PromptMessageType"} |
data · required | {"$ref":"PromptMessageData"} |
pairID · required | {"nullable":true,"type":"string"} |
promptID · required | {"type":"string"} |
PromptMessageData
{"type":"object"}
| Property | Definition |
|---|---|
role · required | {"$ref":"PromptMessageRole"} |
content · required | {"$ref":"Markup"} |
PromptMessageRole
{"type":"string","enum":["system","agent","user"],"x-enumNames":["SYSTEM","AGENT","USER"]}
PromptMessageType
{"type":"string","enum":["role","variable"],"x-enumNames":["ROLE","VARIABLE"]}
PromptSettings
{"type":"object"}
| Property | Definition |
|---|---|
model | {"allOf":[{"$ref":"AIModel"}]} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
responseFormat | {"type":"string"} |
reasoningEffort | {"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]} |
serviceTier | The service tier to request from models that support it. {"nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]} |
useStructuredOutput | {"type":"boolean"} |
PronunciationDictionaryEntry
{"type":"object"}
| Property | Definition |
|---|---|
from · required | {"type":"string","minLength":1,"maxLength":128} |
to · required | {"type":"string","maxLength":128} |
PrototypeIntent
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
name · required | {"type":"string"} |
slots | {"type":"array","items":{"$ref":"PrototypeIntentSlot"}} |
inputs · required | {"type":"array","items":{"$ref":"PrototypeIntentInput"}} |
noteID | {"nullable":true,"type":"string"} |
description | {"type":"string"} |
PrototypeIntentInput
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"type":"string"} |
slots | {"type":"array","items":{"type":"string"}} |
PrototypeIntentSlot
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
dialog · required | {"$ref":"PrototypeIntentSlotDialog"} |
required · required | {"type":"boolean"} |
PrototypeIntentSlotDialog
{"type":"object"}
| Property | Definition |
|---|---|
prompt · required | {"type":"array","items":{}} |
confirm · required | {"type":"array","items":{}} |
utterances · required | {"type":"array","items":{"$ref":"PrototypeIntentInput"}} |
confirmEnabled · required | {"type":"boolean"} |
PrototypeModel
{"type":"object"}
| Property | Definition |
|---|---|
slots · required | {"type":"array","items":{"$ref":"PrototypeSlot"}} |
intents · required | {"type":"array","items":{"$ref":"PrototypeIntent"}} |
PrototypeSlot
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
name · required | {"type":"string"} |
type · required | {"type":"object","properties":{"value":{"type":"string"}}} |
color | {"type":"string"} |
inputs · required | {"type":"array","items":{"type":"string"}} |
description | {"nullable":true,"type":"string"} |
RequiredEntity
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
intentID · required | {"type":"string"} |
entityID · required | {"type":"string"} |
repromptID · required | {"nullable":true,"type":"string"} |
Response
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
name · required | {"type":"string","maxLength":255} |
type | {"default":null,"nullable":true,"allOf":[{"$ref":"ResponseType"}]} |
draft | {"default":null,"nullable":true,"type":"boolean"} |
ResponseDiscriminator
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
channel · required | {"$ref":"Channel"} |
language · required | {"$ref":"Language"} |
responseID · required | {"type":"string"} |
variantOrder · required | {"type":"array","items":{"type":"string"}} |
ResponseMessage
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
text · required | {"$ref":"Markup"} |
delay · required | {"nullable":true,"type":"number"} |
condition · required | {"nullable":true,"allOf":[{"$ref":"AnyCondition"}]} |
discriminatorID · required | {"type":"string"} |
ResponseSimulationTurnTest
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["response"],"x-enumNames":["RESPONSE"]} |
turnID · required | {"type":"string"} |
payload · required | {"$ref":"ResponseSimulationTurnTestPayload"} |
ResponseSimulationTurnTestPayload
{"oneOf":[{"$ref":"SimulationTurnTestJudgeEqual"},{"$ref":"SimulationTurnTestJudgeLLMEval"}]}
ResponseType
{"type":"string","enum":["prompt","message"],"x-enumNames":["PROMPT","MESSAGE"]}
RimelabsVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["rimelabs"],"x-enumNames":["RIMELABS"]} |
model | {"type":"string"} |
voice · required | {"type":"string"} |
language | {"type":"string"} |
RoutingSimulationTurnTest
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["routing"],"x-enumNames":["ROUTING"]} |
turnID · required | {"type":"string"} |
payload · required | {"$ref":"RoutingSimulationTurnTestPayload"} |
RoutingSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
routeTo · required | {"nullable":true,"type":"object","properties":{"resourceID":{"type":"string"},"resourceType":{"$ref":"SimulationTurnTestResourceType"}},"required":["resourceID","resourceType"]} |
shouldRoute · required | {"type":"boolean"} |
STTSettings
{"oneOf":[{"$ref":"ElevenLabsSTTSettings"},{"$ref":"DeepgramSTTSettings"},{"$ref":"AssemblyAISTTSettings"},{"$ref":"CartesiaSTTSettings"},{"$ref":"GladiaSTTSettings"},{"$ref":"GoogleSTTSettings"},{"$ref":"SonioxSTTSettings"}]}
ScriptCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["script"],"x-enumNames":["SCRIPT"]} |
code · required | {"$ref":"CodeText"} |
Secret
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
visibility · required | {"$ref":"SecretVisibility"} |
hasValue | {"type":"boolean"} |
assistantID · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"nullable":true,"type":"number"} |
SecretVisibility
{"type":"string","enum":["restricted","masked"],"x-enumNames":["RESTRICTED","MASKED"]}
Simulation
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
settings · required | {"$ref":"SimulationSettings"} |
turnOrder · required | {"type":"array","items":{"type":"string"}} |
SimulationSettings
{"type":"object"}
| Property | Definition |
|---|---|
launchEvent · required | {"nullable":true,"type":"string"} |
variableStates | {"default":[],"anyOf":[{"type":"string"},{"type":"array","items":{"$ref":"PersonaItem"}}]} |
SimulationSimulationTurn
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["simulation"],"x-enumNames":["SIMULATION"]} |
payload · required | {"$ref":"SimulationSimulationTurnPayload"} |
testOrder · required | {"type":"array","items":{"type":"string"}} |
simulationID · required | {"type":"string"} |
SimulationSimulationTurnPayload
{"type":"object"}
| Property | Definition |
|---|---|
scenario · required | {"type":"string"} |
maxTurns · required | {"type":"number"} |
variableStates · required | {"anyOf":[{"type":"string"},{"type":"array","items":{"$ref":"PersonaItem"}}]} |
successCriteria · required | {"type":"string"} |
SimulationTurn
{"oneOf":[{"$ref":"UserSimulationTurn"},{"$ref":"AgentSimulationTurn"},{"$ref":"SimulationSimulationTurn"}]}
SimulationTurnTest
{"oneOf":[{"$ref":"ToolSimulationTurnTest"},{"$ref":"RoutingSimulationTurnTest"},{"$ref":"ResponseSimulationTurnTest"}]}
SimulationTurnTestJudgeEqual
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["equal"],"x-enumNames":["EQUAL"]} |
value · required | {"type":"string"} |
SimulationTurnTestJudgeLLMEval
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["llm_eval"],"x-enumNames":["LLM_EVAL"]} |
prompt · required | {"type":"string"} |
SimulationTurnTestResourceType
{"type":"string","enum":["flow","agent"],"x-enumNames":["FLOW","AGENT"]}
SimulationTurnTestToolNativeKind
{"type":"string","enum":["end","card","button","carousel","skip-turn","web-search","call-forward","knowledge-base"],"x-enumNames":["END","CARD","BUTTON","CAROUSEL","SKIP_TURN","WEB_SEARCH","CALL_FORWARD","KNOWLEDGE_BASE"]}
SonioxSTTLanguage
{"type":"string","enum":["auto","af","sq","ar","az","eu","be","bn","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","gu","he","hi","hu","id","it","ja","kn","kk","ko","lv","lt","mk","ms","ml","mr","no","fa","pl","pt","pa","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","te","th","tr","uk","ur","vi","cy"],"x-enumNames":["AUTO","AFRIKAANS","ALBANIAN","ARABIC","AZERBAIJANI","BASQUE","BELARUSIAN","BENGALI","BOSNIAN","BULGARIAN","CATALAN","CHINESE","CROATIAN","CZECH","DANISH","DUTCH","ENGLISH","ESTONIAN","FINNISH","FRENCH","GALICIAN","GERMAN","GREEK","GUJARATI","HEBREW","HINDI","HUNGARIAN","INDONESIAN","ITALIAN","JAPANESE","KANNADA","KAZAKH","KOREAN","LATVIAN","LITHUANIAN","MACEDONIAN","MALAY","MALAYALAM","MARATHI","NORWEGIAN","PERSIAN","POLISH","PORTUGUESE","PUNJABI","ROMANIAN","RUSSIAN","SERBIAN","SLOVAK","SLOVENIAN","SPANISH","SWAHILI","SWEDISH","TAGALOG","TAMIL","TELUGU","THAI","TURKISH","UKRAINIAN","URDU","VIETNAMESE","WELSH"]}
SonioxSTTModel
{"type":"string","enum":["stt-rt-v5"],"x-enumNames":["STT_RT_V_5"]}
SonioxSTTSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["soniox"],"x-enumNames":["SONIOX"]} |
model · required | {"$ref":"SonioxSTTModel"} |
maxEndpointDelayMS | {"type":"integer","minimum":500,"maximum":3000} |
endpointSensitivity | {"type":"number","minimum":-1,"maximum":1} |
keyterms | {"type":"string"} |
languages · required | {"type":"array","items":{"$ref":"SonioxSTTLanguage"}} |
SonioxVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
provider · required | {"type":"string","enum":["soniox"],"x-enumNames":["SONIOX"]} |
model | {"type":"string"} |
voice · required | {"type":"string"} |
language | {"type":"string"} |
StableConditionAssertion
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
lhs · required | {"$ref":"ConditionAssertionLhs"} |
rhs · required | {"$ref":"VariableReferenceString"} |
operation | {"default":"is","allOf":[{"$ref":"ConditionOperation"}]} |
StableDeleteResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the deletion. {"type":"string"} |
StableEnvironment
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
alias · required | The URL-safe alias that identifies the environment (e.g. {"type":"string"} |
isMain · required | Whether this is the main (default) environment of the project. {"type":"boolean"} |
releases · required | {"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"backupID":{"type":"number","description":"The ID of the backup that snapshots the environment for this release."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"description":{"nullable":true,"description":"An optional description of what changed in this release.","type":"string"},"autogenerated":{"type":"boolean","description":"Whether the release was created automatically by the system rather than published manually."}},"required":["name","backupID","createdAt","description","autogenerated"]}} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
trafficPercentage · required | The percentage of live traffic (0-100) currently routed to this environment. {"type":"number"} |
StableEnvironmentAuditReport
One list per check. Each entry names the function, agent or tool it is about and says why.
{"type":"object"}
| Property | Definition |
|---|---|
phase1VarSetters · required | {"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"agent":{"type":"string"},"output":{"type":"string"}},"required":["function","agent","output"]}}} |
phase2OrphanDefaults · required | {"type":"array","items":{"type":"object","properties":{"toolID":{"type":"string"},"function":{"type":"string"},"agent":{"type":"string"},"input":{"type":"string"},"defaultVar":{"type":"string"},"note":{"type":"string"}},"required":["toolID","function","agent","input","defaultVar","note"]}} |
phase3ShouldFulfillWithCanonicalSource · required | {"type":"array","items":{"type":"object","properties":{"toolID":{"type":"string"},"function":{"type":"string"},"agent":{"type":"string"},"input":{"type":"string"},"suggestedDefaultVar":{"type":"string"},"note":{"type":"string"}},"required":["toolID","function","agent","input","suggestedDefaultVar","note"]}} |
phase4UncapturedOutputs · required | {"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"output":{"type":"string"},"toolCount":{"type":"number"},"note":{"type":"string"}},"required":["function","output","toolCount","note"]}} |
phase5MalformedWiring · required | {"type":"array","items":{"type":"object","properties":{"toolID":{"type":"string"},"function":{"type":"string"},"agent":{"type":"string"},"input":{"type":"string"},"issue":{"type":"string"},"current":{"type":"string"},"shouldBe":{"type":"string"}},"required":["toolID","function","agent","input","issue","current","shouldBe"]}} |
phase6SuggestedCaptures · required | {"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"output":{"type":"string"},"suggestedVar":{"type":"string"},"currentCapturesTo":{"nullable":true,"type":"array","items":{"type":"string"}},"note":{"type":"string"}},"required":["function","output","suggestedVar","currentCapturesTo","note"]}} |
phase7SideEffectOnly · required | {"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"agents":{"type":"array","items":{"type":"string"}},"note":{"type":"string"}},"required":["function","agents","note"]}} |
phase8OrphanFunctions · required | {"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"inputCount":{"type":"number"},"outputCount":{"type":"number"},"note":{"type":"string"}},"required":["function","inputCount","outputCount","note"]}} |
phase9ArgsSecretsReads · required | {"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"agent":{"type":"string"},"toolID":{"type":"string"}},"required":["agent","toolID"]}},"note":{"type":"string"}},"required":["function","attachments","note"]}} |
phase10EmptyToolDescriptions · required | {"type":"array","items":{"type":"object","properties":{"toolID":{"type":"string"},"function":{"type":"string"},"agent":{"type":"string"},"note":{"type":"string"}},"required":["toolID","function","agent","note"]}} |
StableEnvironmentAuditResponse
{"type":"object"}
| Property | Definition |
|---|---|
audit · required | {"$ref":"StableEnvironmentAuditReport"} |
StableEnvironmentCloneRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
name · required | The display name of the new environment. {"type":"string"} |
alias · required | Short URL-safe identifier; cannot be 'main' (reserved). {"type":"string"} |
StableEnvironmentCompileResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the update. {"type":"string"} |
durationMs · required | How long the compilation took, in milliseconds. {"type":"number"} |
StableEnvironmentDiffChange
{"type":"string","enum":["created","updated","deleted"],"x-enumNames":["CREATED","UPDATED","DELETED"]}
StableEnvironmentDiffReport
{"type":"object"}
| Property | Definition |
|---|---|
created · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
updated · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
deleted · required | {"type":"integer","minimum":0,"maximum":9007199254740991} |
resources · required | The changed resources. Capped; {"type":"array","items":{"$ref":"StableEnvironmentDiffResource"}} |
truncated · required | {"type":"boolean"} |
StableEnvironmentDiffResource
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
id · required | {"type":"string"} |
name · required | {"type":"string"} |
change · required | {"$ref":"StableEnvironmentDiffChange"} |
StableEnvironmentDiffResponse
{"type":"object"}
| Property | Definition |
|---|---|
diff · required | {"$ref":"StableEnvironmentDiffReport"} |
StableEnvironmentExportResponse
{"allOf":[{"$ref":"AssistantExportData"}]}
StableEnvironmentExportResponseV2
A full export of the environment. Rich text is rendered as a string, with {name} for a variable, entity or secret reference and name for a tool, playbook or workflow reference. A chat-text leaf (a tool message example, a card or attachment description, a static no-match or no-reply prompt) carries markdown marks and escapes a literal *, _, ~, [, <u> or </u> with a backslash, as a message read does. A prompt leaf (instructions, persona, guidelines) carries markdown. Every other leaf is plain text with {name} references, no marks and no escapes: a URL, a header, query or body value, a default value, a condition operand, a set value, a code leaf, and an utterance leaf (entity references only). Outside a prompt-kind leaf, a variable, entity or secret whose name is outside the token grammar (letters, digits and underscores, at most 64 characters) renders as its id. A secret inside a prompt-kind leaf renders as its id rather than its name, matching the dedicated agent read. Inside diagrams{}.nodes{}.data only the node types whose data carries rich text are rendered; every other node type ships in its stored object form. messages[] and prompts[] carry the same objects the message and prompt get reads return, rendered the same way, so the text fields of an item can be written back unchanged. The whole item cannot: the write schemas refuse its id, timestamps and user IDs. Read-only.
{"allOf":[{"$ref":"StableExportAssistantExportDataV2"}]}
StableEnvironmentListResponse
{"type":"object"}
| Property | Definition |
|---|---|
environments · required | {"type":"array","items":{"$ref":"StableEnvironment"}} |
StableEnvironmentMergeRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
sourceEnvironmentAlias · required | The alias of the environment whose changes are merged. {"type":"string"} |
targetEnvironmentAlias · required | The alias of the environment that receives the merged changes. {"type":"string"} |
removeSourceEnvironment | If true, the source environment is deleted after the merge. {"default":false,"type":"boolean"} |
StableEnvironmentMergeResponse
{"type":"object"}
| Property | Definition |
|---|---|
sourceEnvironment · required | {"$ref":"StableEnvironment"} |
targetEnvironment · required | {"$ref":"StableEnvironment"} |
targetRelease · required | {"type":"object","properties":{"name":{"type":"string"},"backupID":{"type":"number","description":"The ID of the backup that snapshots the environment for this release."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"description":{"nullable":true,"description":"An optional description of what changed in this release.","type":"string"},"autogenerated":{"type":"boolean","description":"Whether the release was created automatically by the system rather than published manually."}},"required":["name","backupID","createdAt","description","autogenerated"]} |
StableEnvironmentPublishRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
name · required | The name of the release created by publishing. {"type":"string"} |
description | An optional description of what changed in this release. {"default":null,"nullable":true,"type":"string"} |
StableEnvironmentPublishResponse
{"type":"object"}
| Property | Definition |
|---|---|
environment · required | {"$ref":"StableEnvironment"} |
release · required | {"type":"object","properties":{"name":{"type":"string"},"backupID":{"type":"number","description":"The ID of the backup that snapshots the environment for this release."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"description":{"nullable":true,"description":"An optional description of what changed in this release.","type":"string"},"autogenerated":{"type":"boolean","description":"Whether the release was created automatically by the system rather than published manually."}},"required":["name","backupID","createdAt","description","autogenerated"]} |
StableEnvironmentResponse
{"type":"object"}
| Property | Definition |
|---|---|
environment · required | {"$ref":"StableEnvironment"} |
StableEnvironmentSearchTextReadResponse
{"type":"object"}
| Property | Definition |
|---|---|
hits · required | {"type":"array","items":{"$ref":"StableSearchTextHit"}} |
totalMatches · required | Matches in everything searched, not only this page. {"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
byResourceType · required | Matching lines per resource type, in everything searched. {"type":"object","additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}} |
hasMore · required | {"type":"boolean"} |
nextOffset | {"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
incomplete | Present when the search did not read everything: it stopped at its time limit, or a regular expression read only the first 1,000 characters of a longer line. The counts cover only what it read. {"type":"boolean","enum":[true],"x-enumNames":["TRUE"]} |
notSearched · required | What this search never reads. {"type":"array","items":{"type":"string"}} |
StableEnvironmentSearchTextRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
pattern · required | The word, phrase or ID to find. With regex, a JavaScript regular expression. {"type":"string","minLength":1,"maxLength":256} |
regex | Read pattern as a regular expression. Default false: literal text. {"type":"boolean"} |
ignoreCase | Ignore case. Default true. {"type":"boolean"} |
wholeWord | Match only where no letter, digit or underscore touches the match on either side. Default false. {"type":"boolean"} |
resourceTypes | Search only these kinds of resource. Default: all of them. {"minItems":1,"type":"array","items":{"$ref":"StableSearchResourceType"}} |
limit | Hits per page. Default 50. {"type":"integer","minimum":1,"maximum":200} |
offset | Hits to skip: nextOffset from the previous page. {"type":"integer","minimum":0,"maximum":9007199254740991} |
StableEnvironmentUpdateRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
name | {"type":"string"} |
StableEnvironmentUpdateTrafficSplitRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
traffic · required | Map of environmentAlias → traffic percentage (0-100). Values must sum to 100. {"type":"object","additionalProperties":{"type":"number","minimum":0,"maximum":100}} |
StableExportAPITool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
url · required | {"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
body · required | {"nullable":true,"allOf":[{"$ref":"StableExportAPIToolBody"}]} |
image · required | {"nullable":true,"type":"string"} |
headers · required | {"type":"array","items":{"$ref":"StableExportAPIToolKeyValue"}} |
httpMethod · required | {"$ref":"APIToolHTTPMethodType"} |
description · required | {"nullable":true,"type":"string"} |
queryParameters · required | {"type":"array","items":{"$ref":"StableExportAPIToolKeyValue"}} |
settings | {"nullable":true,"allOf":[{"$ref":"APIToolSettings"}]} |
StableExportAPIToolBody
{"oneOf":[{"$ref":"StableExportAPIToolRawBody"},{"$ref":"StableExportAPIToolFormDataBody"},{"$ref":"StableExportAPIToolURLEncodedBody"}]}
StableExportAPIToolFormDataBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["form-data"],"x-enumNames":["FORM_DATA"]} |
formData · required | {"type":"array","items":{"$ref":"StableExportAPIToolKeyValue"}} |
StableExportAPIToolKeyValue / StableExportMcpServerHeaderEntry
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
key · required | {"nullable":true,"type":"string"} |
value · required | {"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
StableExportAPIToolRawBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["raw-input"],"x-enumNames":["RAW_INPUT"]} |
contentType | {"allOf":[{"$ref":"APIToolContentType"}]} |
content · required | {"$ref":"ExportTextString"} |
StableExportAPIToolURLEncodedBody
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["url-encoded"],"x-enumNames":["URL_ENCODED"]} |
params · required | {"type":"array","items":{"$ref":"StableExportAPIToolKeyValue"}} |
StableExportAgent
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
endTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentEndTool"}]} |
settings · required | {"$ref":"AgentSettings"} |
cardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentCardTool"}]} |
isOperator | {"default":false,"type":"boolean"} |
buttonTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentButtonTool"}]} |
description · required | {"nullable":true,"type":"string"} |
instructions · required | {"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
skipTurnTool | {"default":null,"nullable":true,"allOf":[{"$ref":"AgentSkipTurnTool"}]} |
carouselTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentCardTool"}]} |
pathToolOrder · required | {"type":"array","items":{"type":"string"}} |
webSearchTool · required | {"nullable":true,"allOf":[{"$ref":"StableExportAgentWebSearchTool"}]} |
callForwardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentCallForwardTool"}]} |
knowledgeBaseTool · required | {"nullable":true,"allOf":[{"$ref":"StableExportAgentKnowledgeBaseTool"}]} |
StableExportAgentAPITool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
apiToolID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"StableExportToolNodeDataAPIInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"}} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
asyncExecution | {"default":false,"type":"boolean"} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
StableExportAgentButtonTool / StableExportAgentCardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
description · required | {"type":"string"} |
StableExportAgentCallForwardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
address · required | {"$ref":"ExportTextString"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
extension | {"allOf":[{"$ref":"ExportTextString"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
addressType · required | {"$ref":"CallForwardAddressType"} |
callerIDPassthrough | {"type":"boolean"} |
StableExportAgentEndTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
StableExportAgentFunctionTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
functionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"StableExportToolNodeDataFunctionInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"}} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
asyncExecution | {"default":false,"type":"boolean"} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
StableExportAgentIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"StableExportToolNodeDataIntegrationStoredInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"}} |
integrationToolID · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
captureInputVariables | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
extendedInputVariables | {"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolExtendedInputVariable"}} |
extendedInputSchema | {"nullable":true,"type":"object","additionalProperties":{}} |
StableExportAgentKnowledgeBaseMetadataKeyFilter
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
key · required | {"type":"string"} |
StableExportAgentKnowledgeBaseTool
{"type":"object"}
| Property | Definition |
|---|---|
query | {"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
enabled · required | {"type":"boolean"} |
filters | {"type":"array","items":{"$ref":"StableExportAgentKnowledgeBaseMetadataKeyFilter"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
chunkLimit | {"nullable":true,"type":"number"} |
description · required | {"type":"string"} |
queryMode | {"allOf":[{"$ref":"AgentKnowledgeBaseToolQueryMode"}]} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
StableExportAgentMcpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
inputVariables · required | {"type":"object","additionalProperties":{"$ref":"StableExportToolNodeDataMcpIntegrationInputVariable"}} |
captureResponse | {"default":null,"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"}} |
mcpIntegrationToolID · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
agentID · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
captureInputVariables · required | {"nullable":true,"type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}} |
StableExportAgentPathTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
agentID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
variableOrder · required | {"type":"array","items":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
StableExportAgentToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
generative | {"type":"object","properties":{"delay":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"execution":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]}}} |
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
StableExportAgentWebSearchTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportAgentToolMessages"}]} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description | {"type":"string"} |
allowedDomains | {"nullable":true,"type":"array","items":{"type":"string"}} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
StableExportAnyAttachment
{"anyOf":[{"$ref":"StableExportCardAttachment"},{"$ref":"StableExportMediaAttachment"}]}
StableExportAssistantExportDataV2
{"type":"object"}
| Property | Definition |
|---|---|
secrets | {"type":"array","items":{"$ref":"Secret"}} |
project · required | {"$ref":"Project"} |
_version | {"x-speakeasy-name-override":"schemaVersion","type":"string"} |
programs | {"type":"object","additionalProperties":{"$ref":"Program"}} |
assistant | {"nullable":true,"allOf":[{"$ref":"Assistant"}]} |
variableStates | {"type":"array","items":{"$ref":"VariableState"}} |
transcriptEvaluations | {"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["boolean"],"description":"The type of binary evaluations.","x-enumNames":["BOOLEAN"]},"truePrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should evaluate as 'true'."},"falsePrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should evaluate as 'false'."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","truePrompt","falsePrompt","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["number"],"description":"The type of rating evaluations.","x-enumNames":["NUMBER"]},"minimumValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The lowest rating that can be applied."},"minimumPrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should receive lower ratings."},"maximumValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The highest rating that can be applied."},"maximumPrompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes which transcripts should receive higher ratings."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","minimumValue","minimumPrompt","maximumValue","maximumPrompt","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["string"],"description":"The type of text evaluations.","x-enumNames":["STRING"]},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","default"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the evaluation."},"description":{"description":"Description of the evaluation.","nullable":true,"type":"string","maxLength":250},"enabled":{"type":"boolean","description":"When enabled, evaluations will be run on every new transcript."},"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"This prompt describes how the LLM should apply this evaluation."},"settings":{"description":"The model settings passed when invoking this evaluation.","allOf":[{"$ref":"TranscriptEvaluationSettings"}]},"runScope":{"description":"Which transcripts this evaluation runs on automatically, by the publish state of their version.","allOf":[{"$ref":"TranscriptEvaluationRunScope"}]},"type":{"type":"string","enum":["option"],"description":"The type of options evaluations.","x-enumNames":["OPTION"]},"options":{"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"TranscriptEvaluationOptionSchema"},"description":"The options that should be evaluated for."},"systemTag":{"nullable":true,"type":"string","maxLength":255},"id":{"type":"string"},"default":{"type":"boolean"}},"required":["name","enabled","prompt","type","options","default"],"additionalProperties":false}]}} |
version · required | {"$ref":"StableExportVersion"} |
diagrams · required | {"type":"object","additionalProperties":{"$ref":"StableExportDiagram"}} |
intents | {"type":"array","items":{"$ref":"Intent"}} |
utterances | {"type":"array","items":{"$ref":"StableExportUtterance"}} |
requiredEntities | {"type":"array","items":{"$ref":"RequiredEntity"}} |
functions | {"type":"array","items":{"$ref":"Function"}} |
functionPaths | {"type":"array","items":{"$ref":"FunctionPath"}} |
functionVariables | {"type":"array","items":{"$ref":"FunctionVariable"}} |
flows | {"type":"array","items":{"$ref":"Flow"}} |
agents | {"type":"array","items":{"$ref":"StableExportAgent"}} |
agentAPITools | {"default":[],"type":"array","items":{"$ref":"StableExportAgentAPITool"}} |
agentFlowTools | {"default":[],"type":"array","items":{"$ref":"AgentFlowTool"}} |
agentPathTools | {"type":"array","items":{"$ref":"StableExportAgentPathTool"}} |
agentFunctionTools | {"type":"array","items":{"$ref":"StableExportAgentFunctionTool"}} |
agentIntegrationTools | {"default":[],"type":"array","items":{"$ref":"StableExportAgentIntegrationTool"}} |
agentFlowToolVariables | {"default":[],"type":"array","items":{"$ref":"AgentFlowToolVariable"}} |
agentPathToolVariables | {"type":"array","items":{"$ref":"AgentPathToolVariable"}} |
agentMcpIntegrationTools | {"default":[],"type":"array","items":{"$ref":"StableExportAgentMcpIntegrationTool"}} |
events | {"type":"array","items":{"$ref":"Event"}} |
entities | {"type":"array","items":{"$ref":"Entity"}} |
entityVariants | {"type":"array","items":{"$ref":"EntityVariant"}} |
folders | {"type":"array","items":{"$ref":"Folder"}} |
apiTools | {"type":"array","items":{"$ref":"StableExportAPITool"}} |
apiToolInputVariables | {"type":"array","items":{"$ref":"APIToolInputVariable"}} |
simulations | {"type":"array","items":{"$ref":"Simulation"}} |
simulationTurns | {"type":"array","items":{"$ref":"SimulationTurn"}} |
simulationTurnTests | {"type":"array","items":{"$ref":"SimulationTurnTest"}} |
variables | {"type":"array","items":{"$ref":"Variable"}} |
workflows | {"type":"array","items":{"$ref":"Workflow"}} |
attachments | {"type":"array","items":{"$ref":"StableExportAnyAttachment"}} |
cardButtons | {"type":"array","items":{"$ref":"StableExportCardButton"}} |
integrationTools | {"type":"array","items":{"$ref":"IntegrationTool"}} |
mcpIntegrationTools | {"type":"array","items":{"$ref":"McpIntegrationTool"}} |
mcpServers | {"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedByID":{"type":"number"},"assistantID":{"type":"string"},"environmentID":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":64},"folderID":{"nullable":true,"type":"string"},"createdByID":{"type":"number"},"image":{"default":null,"nullable":true,"type":"string"},"description":{"default":null,"nullable":true,"type":"string"},"specification":{"default":"2025-03-26","allOf":[{"$ref":"McpServerSpecification"}]},"url":{"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]},"headers":{"default":null,"nullable":true,"type":"array","items":{"$ref":"StableExportMcpServerHeaderEntry"}},"authType":{"default":"custom","allOf":[{"$ref":"McpServerAuthType"}]},"oauthMetadata":{"default":null,"nullable":true,"allOf":[{"$ref":"McpServerOAuthMetadata"}]}},"required":["id","createdAt","updatedAt","updatedByID","assistantID","name","folderID","createdByID"]}} |
mcpServerTools | {"type":"array","items":{"$ref":"McpServerTool"}} |
personas | {"type":"array","items":{"$ref":"Persona"}} |
kbDocumentVersions | {"type":"array","items":{"$ref":"KBDocumentVersionBackup"}} |
kbSettings | {"nullable":true,"allOf":[{"$ref":"KBSettingsBackup"}]} |
kbDocumentMetadataM2M | {"type":"array","items":{"$ref":"KBDocumentMetadataM2MBackup"}} |
messages · required | {"type":"array","items":{"$ref":"StableMessage"}} |
prompts · required | {"type":"array","items":{"$ref":"StablePrompt"}} |
StableExportCardAttachment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["card"],"x-enumNames":["CARD"]} |
title · required | {"$ref":"ExportTextString"} |
mediaID · required | {"nullable":true,"type":"string"} |
description · required | {"$ref":"ExportTextString"} |
buttonOrder · required | {"type":"array","items":{"type":"string"}} |
StableExportCardButton
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
label · required | {"$ref":"ExportTextString"} |
cardID · required | {"type":"string"} |
StableExportCompiledAgent
{"type":"object"}
| Property | Definition |
|---|---|
settings · required | {"$ref":"AgentSettings"} |
isOperator | {"default":false,"type":"boolean"} |
description · required | {"nullable":true,"type":"string"} |
skipTurnTool | {"nullable":true,"allOf":[{"$ref":"CompiledAgentSkipTurnTool"}]} |
name | {"default":"","type":"string","maxLength":255} |
toolName | {"type":"string"} |
endTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentEndTool"}]} |
cardTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentCardTool"}]} |
buttonTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentButtonTool"}]} |
carouselTool | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentCarouselTool"}]} |
webSearchTool · required | {"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentWebSearchTool"}]} |
apiTools | {"type":"array","items":{"$ref":"StableExportCompiledAgentAPITool"}} |
flowTools | {"type":"array","items":{"$ref":"CompiledAgentFlowTool"}} |
pathTools · required | {"type":"array","items":{"$ref":"StableExportCompiledAgentPathTool"}} |
instructions · required | {"nullable":true,"type":"string"} |
functionTools · required | {"type":"array","items":{"$ref":"StableExportCompiledAgentFunctionTool"}} |
callForwardTool | {"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentCallForwardTool"}]} |
integrationTools | {"type":"array","items":{"$ref":"StableExportCompiledAgentIntegrationTool"}} |
knowledgeBaseTool · required | {"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentKnowledgeBaseTool"}]} |
hasToolNameWarning | {"type":"boolean"} |
mcpIntegrationTools | {"type":"array","items":{"$ref":"StableExportCompiledAgentMcpIntegrationTool"}} |
StableExportCompiledAgentAPITool
{"type":"object"}
| Property | Definition |
|---|---|
apiToolID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
asyncExecution | {"default":false,"type":"boolean"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
StableExportCompiledAgentButtonTool / StableExportCompiledAgentCardTool / StableExportCompiledAgentCarouselTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
description · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
StableExportCompiledAgentCallForwardTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
address · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
extension | {"type":"string"} |
description · required | {"type":"string"} |
addressType · required | {"$ref":"CallForwardAddressType"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
callerIDPassthrough | {"type":"boolean"} |
StableExportCompiledAgentEndTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description · required | {"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
StableExportCompiledAgentFunctionTool
{"type":"object"}
| Property | Definition |
|---|---|
functionID · required | {"type":"string"} |
description · required | {"nullable":true,"type":"string"} |
asyncExecution | {"default":false,"type":"boolean"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
StableExportCompiledAgentIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
integrationToolID · required | {"type":"string"} |
extendedInputVariables | {"nullable":true,"type":"object","additionalProperties":{"$ref":"ToolExtendedInputVariable"}} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
StableExportCompiledAgentKnowledgeBaseTool
{"type":"object"}
| Property | Definition |
|---|---|
query | {"nullable":true,"type":"string"} |
enabled · required | {"type":"boolean"} |
filters | {"type":"array","items":{"$ref":"CompiledAgentKnowledgeBaseMetadataKeyFilter"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
chunkLimit | {"nullable":true,"type":"number"} |
queryMode | {"allOf":[{"$ref":"AgentKnowledgeBaseToolQueryMode"}]} |
sourceUrlsCount | {"nullable":true,"type":"number"} |
description · required | {"type":"string"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
StableExportCompiledAgentMcpIntegrationTool
{"type":"object"}
| Property | Definition |
|---|---|
description · required | {"nullable":true,"type":"string"} |
variables · required | {"type":"object","additionalProperties":{"$ref":"CompiledToolNodeDataVariable"}} |
toolSound | {"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
captureResponse | {"type":"object","additionalProperties":{"type":"string"}} |
capturePropertyResponse | {"type":"object","additionalProperties":{"type":"string"}} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
mcpIntegrationToolID · required | {"type":"string"} |
captureInputVariables | {"type":"object","additionalProperties":{"type":"string"}} |
captureInputProperties | {"type":"object","additionalProperties":{"type":"string"}} |
StableExportCompiledAgentPathTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string","maxLength":255} |
description · required | {"nullable":true,"type":"string"} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
toolName | {"type":"string"} |
variables · required | {"type":"array","items":{"$ref":"CompiledAgentPathToolVariable"}} |
hasToolNameWarning | {"type":"boolean"} |
StableExportCompiledAgentToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
prompts | {"nullable":true,"type":"object","properties":{"delay":{"type":"array","items":{"type":"string"}},"failure":{"type":"array","items":{"type":"string"}},"execution":{"type":"array","items":{"type":"string"}},"completion":{"type":"array","items":{"type":"string"}}}} |
generative | {"type":"object","properties":{"delay":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"execution":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"StableExportToolMessageGenerative"}]}}} |
StableExportCompiledAgentWebSearchTool
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
toolSound | {"default":null,"nullable":true,"allOf":[{"$ref":"ToolNodeDataToolSound"}]} |
description | {"type":"string"} |
allowedDomains | {"nullable":true,"type":"array","items":{"type":"string"}} |
sourceUrlsCount | {"nullable":true,"type":"number","minimum":1,"maximum":5} |
messages | {"default":null,"nullable":true,"allOf":[{"$ref":"StableExportCompiledAgentToolMessages"}]} |
StableExportConditionAssertion
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
lhs · required | {"$ref":"ConditionAssertionLhs"} |
rhs · required | {"$ref":"ExportTextString"} |
operation | {"default":"is","allOf":[{"$ref":"ConditionOperation"}]} |
StableExportCrewNodeDataAgent
{"type":"object"}
| Property | Definition |
|---|---|
agentID · required | {"type":"string"} |
condition | {"nullable":true,"allOf":[{"$ref":"StableExportExpressionCondition"}]} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CrewNodeDataRequiredVariable"}} |
StableExportCrewNodeDataFlow
{"type":"object"}
| Property | Definition |
|---|---|
flowID · required | {"type":"string"} |
condition | {"nullable":true,"allOf":[{"$ref":"StableExportExpressionCondition"}]} |
description · required | {"nullable":true,"type":"string"} |
requiredVariables | {"type":"array","items":{"$ref":"CrewNodeDataRequiredVariable"}} |
StableExportExpressionCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["value-variable"],"x-enumNames":["VALUE_VARIABLE"]} |
matchAll · required | {"type":"boolean"} |
assertions · required | {"type":"array","items":{"$ref":"StableExportConditionAssertion"}} |
StableExportMediaAttachment
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["media"],"x-enumNames":["MEDIA"]} |
url · required | {"$ref":"ExportTextString"} |
name · required | {"type":"string","maxLength":255} |
isAsset · required | {"type":"boolean"} |
datatype · required | {"$ref":"MediaDatatype"} |
StableExportToolMessageGenerative
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
examples | {"type":"array","items":{"$ref":"ExportTextString"}} |
StableExportToolNodeDataAPIInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
apiToolInputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
StableExportToolNodeDataFunctionInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
functionInputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
StableExportToolNodeDataIntegrationStoredInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
integrationToolVariableName · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
draftDefaultValue | {"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
StableExportToolNodeDataMcpIntegrationInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"ExportTextString"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
mcpIntegrationVariableName · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
StableExportUtterance
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
text · required | {"$ref":"ExportTextString"} |
language · required | {"$ref":"Language"} |
intentID · required | {"type":"string"} |
StableExportVersion
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
name · required | {"type":"string"} |
model | {"allOf":[{"$ref":"VersionModel"}]} |
legacyID | {"type":"string"} |
updatedAt | {"type":"string"} |
updatedBy | {"type":"number"} |
settings | {"allOf":[{"$ref":"StableExportVersionSettings"}]} |
_version · required | {"type":"number"} |
creatorID · required | {"type":"number"} |
projectID · required | {"type":"string"} |
manualSave | {"type":"boolean"} |
publishedAt | {"nullable":true,"type":"string"} |
platformData · required | {"$ref":"VersionPlatformData"} |
customBlocks | {"type":"object","additionalProperties":{"$ref":"VersionCustomBlock"}} |
rootDiagramID · required | {"type":"string"} |
canvasTemplates | {"type":"array","items":{"$ref":"VersionCanvasTemplate"}} |
programResources | {"allOf":[{"$ref":"StableExportVersionProgramResources"}]} |
templateDiagramID | {"type":"string"} |
defaultStepColors | {"type":"object","additionalProperties":{"type":"string"}} |
autoSaveFromRestore | {"type":"boolean"} |
notes | @deprecated not used {"type":"object","additionalProperties":{"$ref":"VersionNote"}} |
topics | @deprecated in favor of domains {"type":"array","items":{"$ref":"VersionFolderItem"}} |
folders | @deprecated not used {"type":"object","additionalProperties":{"$ref":"VersionFolder"}} |
domains | @deprecated not used {"type":"array","items":{"$ref":"VersionDomain"}} |
prototype | @deprecated prefer adding version-level compiled artifacts to `programResources {"allOf":[{"$ref":"VersionPrototype"}]} |
components | @deprecated not used {"type":"array","items":{"$ref":"VersionFolderItem"}} |
variables · required | @deprecated not used {"type":"array","items":{"type":"string"}} |
knowledgeBase | @deprecated not used {"allOf":[{"$ref":"VersionKnowledgeBase"}]} |
secondaryVersionID | @deprecated in favor of legacyID {"type":"number"} |
compiledSourceHash | {"type":"string"} |
StableExportVersionProgramResources
{"type":"object"}
| Property | Definition |
|---|---|
flows | {"type":"object","additionalProperties":{"$ref":"CompiledFlow"}} |
agents | {"type":"object","additionalProperties":{"$ref":"StableExportCompiledAgent"}} |
prompts | {"type":"object","additionalProperties":{"$ref":"CompiledPrompt"}} |
apiTools | {"type":"object","additionalProperties":{"$ref":"CompiledAPITool"}} |
messages · required | {"type":"object","additionalProperties":{"$ref":"CompiledMessage"}} |
globalCrew | {"allOf":[{"$ref":"VersionProgramResourcesGlobalCrew"}]} |
globalPrompts | {"nullable":true,"allOf":[{"$ref":"VersionProgramResourcesGlobalPrompts"}]} |
costControl | {"nullable":true,"allOf":[{"$ref":"VersionProgramResourcesCostControl"}]} |
secretNameToId | {"type":"object","additionalProperties":{"type":"string"}} |
mcpServers | {"type":"object","additionalProperties":{"$ref":"CompiledMcpServer"}} |
mcpServerTools | {"type":"object","additionalProperties":{"$ref":"CompiledMcpServerTool"}} |
integrationTools | {"type":"object","additionalProperties":{"$ref":"CompiledIntegrationTool"}} |
mcpIntegrationTools | {"type":"object","additionalProperties":{"$ref":"CompiledMcpIntegrationTool"}} |
StableExportVersionSettings
{"type":"object"}
| Property | Definition |
|---|---|
ui | {"allOf":[{"$ref":"VersionSettingsUI"}]} |
llm | {"allOf":[{"$ref":"StableExportVersionSettingsLLM"}]} |
time | {"allOf":[{"$ref":"VersionSettingsTime"}]} |
voice | {"allOf":[{"$ref":"VersionSettingsVoice"}]} |
widget | {"allOf":[{"$ref":"WidgetSettings"}]} |
interfaceConfig | {"allOf":[{"$ref":"InterfaceConfig"}]} |
defaultWidget | {"allOf":[{"$ref":"VersionSettingsDefaultWidget"}]} |
memory | {"allOf":[{"$ref":"VersionSettingsMemory"}]} |
session | {"allOf":[{"$ref":"VersionSettingsSession"}]} |
security | {"allOf":[{"$ref":"VersionSettingsSecurity"}]} |
framework | {"allOf":[{"$ref":"VersionSettingsFramework"}]} |
analytics | {"allOf":[{"$ref":"VersionSettingsAnalytics"}]} |
costControl | {"allOf":[{"$ref":"StableExportVersionSettingsCostControl"}]} |
globalCrew | {"allOf":[{"$ref":"StableExportVersionSettingsGlobalCrew"}]} |
llmFallback | {"allOf":[{"$ref":"LLMFallbackSettings"}]} |
globalNoReply | {"allOf":[{"$ref":"StableExportVersionSettingsGlobalNoReply"}]} |
globalNoMatch | {"allOf":[{"$ref":"StableExportVersionSettingsGlobalNoMatch"}]} |
shareableLink | {"nullable":true,"allOf":[{"$ref":"VersionSettingsShareableLink"}]} |
automaticReprompt | {"allOf":[{"$ref":"VersionSettingsAutomaticReprompt"}]} |
intentClassification · required | {"$ref":"IntentClassificationSettings"} |
StableExportVersionSettingsCostControl
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
maxDollars · required | {"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":10000} |
endMessage · required | {"$ref":"ExportTextString"} |
StableExportVersionSettingsGlobalCrew
{"type":"object"}
| Property | Definition |
|---|---|
agentID · required | {"type":"string"} |
agentDescription | Should not be used, use global agent description instead {"deprecated":true,"nullable":true,"type":"string"} |
subFlows · required | {"type":"array","items":{"$ref":"StableExportCrewNodeDataFlow"}} |
subAgents · required | {"type":"array","items":{"$ref":"StableExportCrewNodeDataAgent"}} |
StableExportVersionSettingsGlobalNoMatch
{"oneOf":[{"$ref":"StableExportVersionSettingsGlobalNoMatchStatic"},{"$ref":"VersionSettingsGlobalNoMatchGenerative"}]}
StableExportVersionSettingsGlobalNoMatchStatic
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["static"],"x-enumNames":["STATIC"]} |
prompt · required | {"$ref":"ExportTextString"} |
StableExportVersionSettingsGlobalNoReply
{"anyOf":[{"$ref":"StableExportVersionSettingsGlobalNoReplyStatic"},{"$ref":"VersionSettingsGlobalNoReplyGenerative"}]}
StableExportVersionSettingsGlobalNoReplyStatic
{"type":"object"}
| Property | Definition |
|---|---|
delay · required | {"nullable":true,"type":"number"} |
enabled · required | {"type":"boolean"} |
maxRetries | {"type":"number"} |
type | {"type":"string","enum":["static"],"x-enumNames":["STATIC"]} |
prompt · required | {"$ref":"ExportTextString"} |
StableExportVersionSettingsLLM
{"type":"object"}
| Property | Definition |
|---|---|
globalPrompts | {"type":"object","properties":{"persona":{"nullable":true,"allOf":[{"$ref":"ExportTextString"}]},"guidelines":{"nullable":true,"allOf":[{"$ref":"ExportTextString"}]}}} |
defaultModels | {"type":"object","properties":{"global":{"type":"object","properties":{"model":{"allOf":[{"$ref":"AIModel"}]},"maxTokens":{"type":"number"},"temperature":{"type":"number"},"reasoningEffort":{"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]},"serviceTier":{"description":"The service tier to request from models that support it. `priority` is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level `priorityProcessing` setting applies.","nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]}}}}} |
globalAgentID | @deprecated Use globalCrew.agentID instead {"type":"string"} |
priorityProcessing | @deprecated Faster processing is set per model: use {"type":"boolean"} |
StableExpressionCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["value-variable"],"x-enumNames":["VALUE_VARIABLE"]} |
matchAll · required | {"type":"boolean"} |
assertions · required | {"type":"array","items":{"$ref":"StableConditionAssertion"}} |
StableMessage
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
variants · required | Every variant, in stored order. Variants are alternatives: the runtime says one of them each time. The first variant cannot be given a condition. {"type":"array","items":{"$ref":"StableMessageVariant"}} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
createdByID · required | The user who created the message. {"type":"number"} |
updatedByID · required | The user who last changed the message or one of its variants. {"type":"number"} |
StableMessageVariant
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
text · required | {"$ref":"MarkdownLikeString"} |
delay · required | Milliseconds to wait before this variant is sent. {"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
condition · required | {"nullable":true,"allOf":[{"$ref":"StableMessageVariantCondition"}]} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | The user who last changed this variant. {"nullable":true,"type":"number"} |
StableMessageVariantCondition
When the runtime may use this variant. value-variable compares variables with values; script runs code in which {variable_name} reads a variable.
{"oneOf":[{"$ref":"StableExpressionCondition"},{"$ref":"StableScriptCondition"}]}
StablePrompt
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
system · required | {"$ref":"VariableReferenceString"} |
settings · required | {"$ref":"PromptSettings"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
createdByID · required | The user who created the prompt. {"type":"number"} |
updatedByID · required | The user who last changed the prompt, its settings or its system text. {"type":"number"} |
StableScriptCondition
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["script"],"x-enumNames":["SCRIPT"]} |
code · required | {"$ref":"VariableReferenceString"} |
StableSearchResourceType
{"type":"string","enum":["agent","playbook","workflow","message","prompt","agent_tool","function","api_tool","integration_tool","mcp_tool","mcp_server","variable","entity","intent","event","test","evaluation","persona","attachment","folder","initialization_workflow","canvas","project"],"x-enumNames":["AGENT","PLAYBOOK","WORKFLOW","MESSAGE","PROMPT","AGENT_TOOL","FUNCTION","API_TOOL","INTEGRATION_TOOL","MCP_TOOL","MCP_SERVER","VARIABLE","ENTITY","INTENT","EVENT","TEST","EVALUATION","PERSONA","ATTACHMENT","FOLDER","INITIALIZATION_WORKFLOW","CANVAS","PROJECT"]}
StableSearchTextHit
{"type":"object"}
| Property | Definition |
|---|---|
resourceType · required | {"$ref":"StableSearchResourceType"} |
resourceID · required | The ID to read the resource with. For a workflow, the workflow ID. A canvas no workflow owns carries its diagram ID and the Initialization Workflow its own ID; no workflow read takes either. When ownerID is set, the row lives inside that owner: read the owner. {"type":"string"} |
resourceName | {"type":"string"} |
ownerID | For a row inside another resource, such as a function path, a tool attachment or a test assertion: the owner to read it with. {"type":"string"} |
blockID | For a hit on a workflow canvas: the block. {"type":"string"} |
stepID | For a hit on a workflow canvas: the step or action. {"type":"string"} |
stepKind | {"type":"string"} |
field · required | Where in the resource the text is, as a path such as instructions, data.name or variants[0].text. {"type":"string"} |
line · required | The 1-based line within that field. {"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
count · required | Matches on that line. {"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
snippet · required | The line around the first match, at most 120 characters. {"type":"string"} |
usedBy | For a message or prompt: the steps and resources that hold its ID, at most 20. A holder inside another resource carries ownerID. {"type":"array","items":{"$ref":"StableSearchTextHolder"}} |
StableSearchTextHolder
{"type":"object"}
| Property | Definition |
|---|---|
resourceType · required | {"$ref":"StableSearchResourceType"} |
resourceID · required | {"type":"string"} |
resourceName | {"type":"string"} |
ownerID | For a row inside another resource, such as a tool attachment: the owner to read it with. {"type":"string"} |
blockID | {"type":"string"} |
stepID | {"type":"string"} |
StableUpdateResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the update. {"type":"string"} |
SystemOneModel
{"type":"string","enum":["clef-flash","voiceflow-classify"],"x-enumNames":["CLEF_FLASH","VOICEFLOW_CLASSIFY"]}
TextContentPart
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
text · required | {"type":"string"} |
Timezone
{"type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Inuvik","America/Iqaluit","America/Jamaica","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Riyadh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kyiv","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Wake","Pacific/Wallis","UTC"],"x-enumNames":["AFRICA_ABIDJAN","AFRICA_ACCRA","AFRICA_ADDIS_ABABA","AFRICA_ALGIERS","AFRICA_ASMERA","AFRICA_BAMAKO","AFRICA_BANGUI","AFRICA_BANJUL","AFRICA_BISSAU","AFRICA_BLANTYRE","AFRICA_BRAZZAVILLE","AFRICA_BUJUMBURA","AFRICA_CAIRO","AFRICA_CASABLANCA","AFRICA_CEUTA","AFRICA_CONAKRY","AFRICA_DAKAR","AFRICA_DAR_ES_SALAAM","AFRICA_DJIBOUTI","AFRICA_DOUALA","AFRICA_EL_AAIUN","AFRICA_FREETOWN","AFRICA_GABORONE","AFRICA_HARARE","AFRICA_JOHANNESBURG","AFRICA_JUBA","AFRICA_KAMPALA","AFRICA_KHARTOUM","AFRICA_KIGALI","AFRICA_KINSHASA","AFRICA_LAGOS","AFRICA_LIBREVILLE","AFRICA_LOME","AFRICA_LUANDA","AFRICA_LUBUMBASHI","AFRICA_LUSAKA","AFRICA_MALABO","AFRICA_MAPUTO","AFRICA_MASERU","AFRICA_MBABANE","AFRICA_MOGADISHU","AFRICA_MONROVIA","AFRICA_NAIROBI","AFRICA_NDJAMENA","AFRICA_NIAMEY","AFRICA_NOUAKCHOTT","AFRICA_OUAGADOUGOU","AFRICA_PORTO_NOVO","AFRICA_SAO_TOME","AFRICA_TRIPOLI","AFRICA_TUNIS","AFRICA_WINDHOEK","AMERICA_ADAK","AMERICA_ANCHORAGE","AMERICA_ANGUILLA","AMERICA_ANTIGUA","AMERICA_ARAGUAINA","AMERICA_ARGENTINA_BUENOS_AIRES","AMERICA_ARGENTINA_CATAMARCA","AMERICA_ARGENTINA_CORDOBA","AMERICA_ARGENTINA_JUJUY","AMERICA_ARGENTINA_LA_RIOJA","AMERICA_ARGENTINA_MENDOZA","AMERICA_ARGENTINA_RIO_GALLEGOS","AMERICA_ARGENTINA_SALTA","AMERICA_ARGENTINA_SAN_JUAN","AMERICA_ARGENTINA_SAN_LUIS","AMERICA_ARGENTINA_TUCUMAN","AMERICA_ARGENTINA_USHUAIA","AMERICA_ARUBA","AMERICA_ASUNCION","AMERICA_ATIKOKAN","AMERICA_BAHIA","AMERICA_BAHIA_BANDERAS","AMERICA_BARBADOS","AMERICA_BELEM","AMERICA_BELIZE","AMERICA_BLANC_SABLON","AMERICA_BOA_VISTA","AMERICA_BOGOTA","AMERICA_BOISE","AMERICA_CAMBRIDGE_BAY","AMERICA_CAMPO_GRANDE","AMERICA_CANCUN","AMERICA_CARACAS","AMERICA_CAYENNE","AMERICA_CAYMAN","AMERICA_CHICAGO","AMERICA_CHIHUAHUA","AMERICA_CIUDAD_JUAREZ","AMERICA_COSTA_RICA","AMERICA_CRESTON","AMERICA_CUIABA","AMERICA_CURACAO","AMERICA_DANMARKSHAVN","AMERICA_DAWSON","AMERICA_DAWSON_CREEK","AMERICA_DENVER","AMERICA_DETROIT","AMERICA_DOMINICA","AMERICA_EDMONTON","AMERICA_EIRUNEPE","AMERICA_EL_SALVADOR","AMERICA_FORT_NELSON","AMERICA_FORTALEZA","AMERICA_GLACE_BAY","AMERICA_GOOSE_BAY","AMERICA_GRAND_TURK","AMERICA_GRENADA","AMERICA_GUADELOUPE","AMERICA_GUATEMALA","AMERICA_GUAYAQUIL","AMERICA_GUYANA","AMERICA_HALIFAX","AMERICA_HAVANA","AMERICA_HERMOSILLO","AMERICA_INDIANA_INDIANAPOLIS","AMERICA_INDIANA_KNOX","AMERICA_INDIANA_MARENGO","AMERICA_INDIANA_PETERSBURG","AMERICA_INDIANA_TELL_CITY","AMERICA_INDIANA_VEVAY","AMERICA_INDIANA_VINCENNES","AMERICA_INDIANA_WINAMAC","AMERICA_INUVIK","AMERICA_IQALUIT","AMERICA_JAMAICA","AMERICA_JUNEAU","AMERICA_KENTUCKY_LOUISVILLE","AMERICA_KENTUCKY_MONTICELLO","AMERICA_KRALENDIJK","AMERICA_LA_PAZ","AMERICA_LIMA","AMERICA_LOS_ANGELES","AMERICA_LOWER_PRINCES","AMERICA_MACEIO","AMERICA_MANAGUA","AMERICA_MANAUS","AMERICA_MARIGOT","AMERICA_MARTINIQUE","AMERICA_MATAMOROS","AMERICA_MAZATLAN","AMERICA_MENOMINEE","AMERICA_MERIDA","AMERICA_METLAKATLA","AMERICA_MEXICO_CITY","AMERICA_MIQUELON","AMERICA_MONCTON","AMERICA_MONTERREY","AMERICA_MONTEVIDEO","AMERICA_MONTSERRAT","AMERICA_NASSAU","AMERICA_NEW_YORK","AMERICA_NIPIGON","AMERICA_NOME","AMERICA_NORONHA","AMERICA_NORTH_DAKOTA_BEULAH","AMERICA_NORTH_DAKOTA_CENTER","AMERICA_NORTH_DAKOTA_NEW_SALEM","AMERICA_NUUK","AMERICA_OJINAGA","AMERICA_PANAMA","AMERICA_PANGNIRTUNG","AMERICA_PARAMARIBO","AMERICA_PHOENIX","AMERICA_PORT_AU_PRINCE","AMERICA_PORT_OF_SPAIN","AMERICA_PORTO_VELHO","AMERICA_PUERTO_RICO","AMERICA_PUNTA_ARENAS","AMERICA_RAINY_RIVER","AMERICA_RANKIN_INLET","AMERICA_RECIFE","AMERICA_REGINA","AMERICA_RESOLUTE","AMERICA_RIO_BRANCO","AMERICA_SANTAREM","AMERICA_SANTIAGO","AMERICA_SANTO_DOMINGO","AMERICA_SAO_PAULO","AMERICA_SCORESBYSUND","AMERICA_SITKA","AMERICA_ST_BARTHELEMY","AMERICA_ST_JOHNS","AMERICA_ST_KITTS","AMERICA_ST_LUCIA","AMERICA_ST_THOMAS","AMERICA_ST_VINCENT","AMERICA_SWIFT_CURRENT","AMERICA_TEGUCIGALPA","AMERICA_THULE","AMERICA_THUNDER_BAY","AMERICA_TIJUANA","AMERICA_TORONTO","AMERICA_TORTOLA","AMERICA_VANCOUVER","AMERICA_WHITEHORSE","AMERICA_WINNIPEG","AMERICA_YAKUTAT","AMERICA_YELLOWKNIFE","ANTARCTICA_CASEY","ANTARCTICA_DAVIS","ANTARCTICA_DUMONTDURVILLE","ANTARCTICA_MACQUARIE","ANTARCTICA_MAWSON","ANTARCTICA_MCMURDO","ANTARCTICA_PALMER","ANTARCTICA_ROTHERA","ANTARCTICA_SYOWA","ANTARCTICA_TROLL","ANTARCTICA_VOSTOK","ARCTIC_LONGYEARBYEN","ASIA_ADEN","ASIA_ALMATY","ASIA_AMMAN","ASIA_ANADYR","ASIA_AQTAU","ASIA_AQTOBE","ASIA_ASHGABAT","ASIA_ATYRAU","ASIA_BAGHDAD","ASIA_BAHRAIN","ASIA_BAKU","ASIA_BANGKOK","ASIA_BARNAUL","ASIA_BEIRUT","ASIA_BISHKEK","ASIA_BRUNEI","ASIA_CHITA","ASIA_CHOIBALSAN","ASIA_COLOMBO","ASIA_DAMASCUS","ASIA_DHAKA","ASIA_DILI","ASIA_DUBAI","ASIA_DUSHANBE","ASIA_FAMAGUSTA","ASIA_GAZA","ASIA_HEBRON","ASIA_HO_CHI_MINH","ASIA_HONG_KONG","ASIA_HOVD","ASIA_IRKUTSK","ASIA_JAKARTA","ASIA_JAYAPURA","ASIA_JERUSALEM","ASIA_KABUL","ASIA_KAMCHATKA","ASIA_KARACHI","ASIA_KATHMANDU","ASIA_KHANDYGA","ASIA_KOLKATA","ASIA_KRASNOYARSK","ASIA_KUALA_LUMPUR","ASIA_KUCHING","ASIA_KUWAIT","ASIA_MACAU","ASIA_MAGADAN","ASIA_MAKASSAR","ASIA_MANILA","ASIA_MUSCAT","ASIA_NICOSIA","ASIA_NOVOKUZNETSK","ASIA_NOVOSIBIRSK","ASIA_OMSK","ASIA_ORAL","ASIA_PHNOM_PENH","ASIA_PONTIANAK","ASIA_PYONGYANG","ASIA_QATAR","ASIA_QOSTANAY","ASIA_QYZYLORDA","ASIA_RIYADH","ASIA_SAKHALIN","ASIA_SAMARKAND","ASIA_SEOUL","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_SREDNEKOLYMSK","ASIA_TAIPEI","ASIA_TASHKENT","ASIA_TBILISI","ASIA_TEHRAN","ASIA_THIMPHU","ASIA_TOKYO","ASIA_TOMSK","ASIA_ULAANBAATAR","ASIA_URUMQI","ASIA_UST_NERA","ASIA_VIENTIANE","ASIA_VLADIVOSTOK","ASIA_YAKUTSK","ASIA_YANGON","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_BERMUDA","ATLANTIC_CANARY","ATLANTIC_CAPE_VERDE","ATLANTIC_FAROE","ATLANTIC_MADEIRA","ATLANTIC_REYKJAVIK","ATLANTIC_SOUTH_GEORGIA","ATLANTIC_ST_HELENA","ATLANTIC_STANLEY","AUSTRALIA_ADELAIDE","AUSTRALIA_BRISBANE","AUSTRALIA_BROKEN_HILL","AUSTRALIA_DARWIN","AUSTRALIA_EUCLA","AUSTRALIA_HOBART","AUSTRALIA_LINDEMAN","AUSTRALIA_LORD_HOWE","AUSTRALIA_MELBOURNE","AUSTRALIA_PERTH","AUSTRALIA_SYDNEY","EUROPE_AMSTERDAM","EUROPE_ANDORRA","EUROPE_ASTRAKHAN","EUROPE_ATHENS","EUROPE_BELGRADE","EUROPE_BERLIN","EUROPE_BRATISLAVA","EUROPE_BRUSSELS","EUROPE_BUCHAREST","EUROPE_BUDAPEST","EUROPE_BUSINGEN","EUROPE_CHISINAU","EUROPE_COPENHAGEN","EUROPE_DUBLIN","EUROPE_GIBRALTAR","EUROPE_GUERNSEY","EUROPE_HELSINKI","EUROPE_ISLE_OF_MAN","EUROPE_ISTANBUL","EUROPE_JERSEY","EUROPE_KALININGRAD","EUROPE_KYIV","EUROPE_KIROV","EUROPE_LISBON","EUROPE_LJUBLJANA","EUROPE_LONDON","EUROPE_LUXEMBOURG","EUROPE_MADRID","EUROPE_MALTA","EUROPE_MARIEHAMN","EUROPE_MINSK","EUROPE_MONACO","EUROPE_MOSCOW","EUROPE_OSLO","EUROPE_PARIS","EUROPE_PODGORICA","EUROPE_PRAGUE","EUROPE_RIGA","EUROPE_ROME","EUROPE_SAMARA","EUROPE_SAN_MARINO","EUROPE_SARAJEVO","EUROPE_SARATOV","EUROPE_SIMFEROPOL","EUROPE_SKOPJE","EUROPE_SOFIA","EUROPE_STOCKHOLM","EUROPE_TALLINN","EUROPE_TIRANE","EUROPE_ULYANOVSK","EUROPE_UZHGOROD","EUROPE_VADUZ","EUROPE_VATICAN","EUROPE_VIENNA","EUROPE_VILNIUS","EUROPE_VOLGOGRAD","EUROPE_WARSAW","EUROPE_ZAGREB","EUROPE_ZAPOROZHYE","EUROPE_ZURICH","INDIAN_ANTANANARIVO","INDIAN_CHAGOS","INDIAN_CHRISTMAS","INDIAN_COCOS","INDIAN_COMORO","INDIAN_KERGUELEN","INDIAN_MAHE","INDIAN_MALDIVES","INDIAN_MAURITIUS","INDIAN_MAYOTTE","INDIAN_REUNION","PACIFIC_APIA","PACIFIC_AUCKLAND","PACIFIC_BOUGAINVILLE","PACIFIC_CHATHAM","PACIFIC_CHUUK","PACIFIC_EASTER","PACIFIC_EFATE","PACIFIC_ENDERBURY","PACIFIC_FAKAOFO","PACIFIC_FIJI","PACIFIC_FUNAFUTI","PACIFIC_GALAPAGOS","PACIFIC_GAMBIER","PACIFIC_GUADALCANAL","PACIFIC_GUAM","PACIFIC_HONOLULU","PACIFIC_KIRITIMATI","PACIFIC_KOSRAE","PACIFIC_KWAJALEIN","PACIFIC_MAJURO","PACIFIC_MARQUESAS","PACIFIC_MIDWAY","PACIFIC_NAURU","PACIFIC_NIUE","PACIFIC_NORFOLK","PACIFIC_NOUMEA","PACIFIC_PAGO_PAGO","PACIFIC_PALAU","PACIFIC_PITCAIRN","PACIFIC_POHNPEI","PACIFIC_PORT_MORESBY","PACIFIC_RAROTONGA","PACIFIC_SAIPAN","PACIFIC_TAHITI","PACIFIC_TARAWA","PACIFIC_TONGATAPU","PACIFIC_WAKE","PACIFIC_WALLIS","UTC"]}
ToolExtendedInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
schema | {} |
metadata | {"type":"object","additionalProperties":{}} |
draft | {"allOf":[{"$ref":"ToolExtendedInputVariableSlot"}]} |
ToolExtendedInputVariableSlot
{"type":"object"}
| Property | Definition |
|---|---|
schema | {} |
metadata | {"type":"object","additionalProperties":{}} |
ToolMessageGenerative
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
examples | {"type":"array","items":{"$ref":"Markup"}} |
ToolNodeCaptureType
{"type":"string","enum":["variable","property"],"x-enumNames":["VARIABLE","PROPERTY"]}
ToolNodeDataAPICaptureResponse / ToolNodeDataIntegrationCaptureResponse / ToolNodeDataMcpIntegrationCaptureResponse
{"type":"object"}
| Property | Definition |
|---|---|
path · required | {"type":"string"} |
variableOrEntityID · required | {"nullable":true,"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataAPIInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
apiToolInputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataFunctionCaptureResponse
{"type":"object"}
| Property | Definition |
|---|---|
variableOrEntityID · required | {"nullable":true,"type":"string"} |
functionOutputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataFunctionInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
functionInputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataIntegrationStoredInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
integrationToolVariableName · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
draftDefaultValue | {"nullable":true,"allOf":[{"$ref":"Markup"}]} |
ToolNodeDataMcpIntegrationInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
description | {"default":null,"nullable":true,"type":"string"} |
defaultValue | {"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]} |
shouldFulfill | If true, then LLM will never ask user to fulfill an input variable. If false, then LLM will decide for itself whether user needs to provide a value for the input variable. {"type":"boolean"} |
mcpIntegrationVariableName · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataToolSound
{"type":"object"}
| Property | Definition |
|---|---|
ref · required | {"nullable":true,"type":"string"} |
volume | {"default":0.75,"type":"number","minimum":0,"maximum":1} |
ToolSimulationTurnTest
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["tool"],"x-enumNames":["TOOL"]} |
turnID · required | {"type":"string"} |
payload · required | {"$ref":"ToolSimulationTurnTestPayload"} |
ToolSimulationTurnTestPayload
{"type":"object"}
| Property | Definition |
|---|---|
tool · required | {"nullable":true,"allOf":[{"$ref":"ToolSimulationTurnTestPayloadTool"}]} |
shouldCall · required | {"type":"boolean"} |
ToolSimulationTurnTestPayloadTool
{"oneOf":[{"$ref":"NativeToolSimulationTurnTestPayload"},{"$ref":"ApiCallToolSimulationTurnTestPayload"},{"$ref":"FunctionToolSimulationTurnTestPayload"},{"$ref":"IntegrationToolSimulationTurnTestPayload"},{"$ref":"McpIntegrationToolSimulationTurnTestPayload"}]}
TranscriptEvaluationOptionSchema
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
value · required | {"type":"string","minLength":1,"maxLength":100} |
prompt · required | {"type":"string","minLength":1,"maxLength":10000} |
included · required | {"type":"boolean"} |
color · required | {"type":"string"} |
TranscriptEvaluationRunScope
{"type":"string","enum":["both","draft","published"],"x-enumNames":["BOTH","DRAFT","PUBLISHED"]}
TranscriptEvaluationSettings
{"nullable":true,"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
model | {"type":"string"} |
realtime | {"type":"object","properties":{"voice":{"type":"string"},"eagerness":{"type":"string"}},"additionalProperties":false} |
maxTokens | {"type":"number"} |
temperature | {"type":"number"} |
reasoningEffort | {"anyOf":[{"$ref":"AIReasoningEffort"},{"type":"string","nullable":true,"enum":[null]}]} |
serviceTier | The service tier to request from models that support it. {"anyOf":[{"$ref":"AIParamsServiceTier"},{"type":"string","nullable":true,"enum":[null]}]} |
explainResults | Whether each result includes a written explanation. Text evaluations always do. {"type":"boolean"} |
UserSimulationTurn
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
environmentID | {"type":"string"} |
type · required | {"type":"string","enum":["user"],"x-enumNames":["USER"]} |
payload · required | {"$ref":"UserSimulationTurnPayload"} |
testOrder · required | {"type":"array","items":{"type":"string"}} |
simulationID · required | {"type":"string"} |
UserSimulationTurnPayload
{"type":"object"}
| Property | Definition |
|---|---|
response · required | {"type":"string"} |
variableStates · required | {"anyOf":[{"type":"string"},{"type":"array","items":{"$ref":"PersonaItem"}}]} |
Utterance
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID | {"nullable":true,"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
text · required | {"$ref":"UtteranceText"} |
language · required | {"$ref":"Language"} |
intentID · required | {"type":"string"} |
UtteranceText
{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"UtteranceTextEntityReference"},{"$ref":"UtteranceTextSpan"}]}}
UtteranceTextSpan
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"$ref":"UtteranceText"} |
attributes | {"type":"object","additionalProperties":{}} |
Variable
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
name · required | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
color · required | {"type":"string"} |
isArray · required | {"type":"boolean"} |
isSystem · required | {"type":"boolean"} |
datatype · required | {"$ref":"VariableDatatype"} |
description · required | {"nullable":true,"type":"string"} |
defaultValue · required | {"nullable":true,"type":"string"} |
resetAfter | {"default":"never","type":"string","enum":["never","session"],"x-enumNames":["NEVER","EACH_SESSION"]} |
VariableDatatype
{"type":"string","enum":["any","text","date","image","number","boolean","string"],"x-enumNames":["ANY","TEXT","DATE","IMAGE","NUMBER","BOOLEAN","STRING"]}
VariableReferenceString
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
{"type":"string"}
VariableState
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
name · required | {"type":"string"} |
projectID · required | {"type":"string"} |
variables · required | {"type":"object","additionalProperties":{}} |
startFrom | {"nullable":true,"allOf":[{"$ref":"VariableStateStartFrom"}]} |
VariableStateStartFrom
{"type":"object"}
| Property | Definition |
|---|---|
stepID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
Version
{"type":"object"}
| Property | Definition |
|---|---|
_id · required | {"type":"string"} |
name · required | {"type":"string"} |
model | {"allOf":[{"$ref":"VersionModel"}]} |
legacyID | {"type":"string"} |
updatedAt | {"type":"string"} |
updatedBy | {"type":"number"} |
settings | {"allOf":[{"$ref":"VersionSettings"}]} |
_version · required | {"type":"number"} |
creatorID · required | {"type":"number"} |
projectID · required | {"type":"string"} |
manualSave | {"type":"boolean"} |
publishedAt | {"nullable":true,"type":"string"} |
platformData · required | {"$ref":"VersionPlatformData"} |
customBlocks | {"type":"object","additionalProperties":{"$ref":"VersionCustomBlock"}} |
rootDiagramID · required | {"type":"string"} |
canvasTemplates | {"type":"array","items":{"$ref":"VersionCanvasTemplate"}} |
programResources | {"allOf":[{"$ref":"VersionProgramResources"}]} |
templateDiagramID | {"type":"string"} |
defaultStepColors | {"type":"object","additionalProperties":{"type":"string"}} |
autoSaveFromRestore | {"type":"boolean"} |
notes | @deprecated not used {"type":"object","additionalProperties":{"$ref":"VersionNote"}} |
topics | @deprecated in favor of domains {"type":"array","items":{"$ref":"VersionFolderItem"}} |
folders | @deprecated not used {"type":"object","additionalProperties":{"$ref":"VersionFolder"}} |
domains | @deprecated not used {"type":"array","items":{"$ref":"VersionDomain"}} |
prototype | @deprecated prefer adding version-level compiled artifacts to `programResources {"allOf":[{"$ref":"VersionPrototype"}]} |
components | @deprecated not used {"type":"array","items":{"$ref":"VersionFolderItem"}} |
variables · required | @deprecated not used {"type":"array","items":{"type":"string"}} |
knowledgeBase | @deprecated not used {"allOf":[{"$ref":"VersionKnowledgeBase"}]} |
secondaryVersionID | @deprecated in favor of legacyID {"type":"number"} |
compiledSourceHash | {"type":"string"} |
VersionCanvasTemplate
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
color · required | {"nullable":true,"type":"string"} |
nodeIDs · required | {"type":"array","items":{"type":"string"}} |
VersionCustomBlock
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
name · required | {"type":"string"} |
body | {"type":"string"} |
stop | {"type":"boolean"} |
paths | {"type":"array","items":{"type":"string"}} |
parameters | {"type":"object","additionalProperties":{"$ref":"VersionCustomBlockParameter"}} |
defaultPath | {"type":"number"} |
VersionCustomBlockParameter
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
VersionDomain
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
live · required | {"type":"boolean"} |
status | {"type":"string"} |
topicIDs · required | {"type":"array","items":{"type":"string"}} |
updatedBy | {"type":"number"} |
updatedAt | {"type":"string"} |
rootDiagramID · required | {"type":"string"} |
updatedByCreatorID | @deprecated in favor of updatedBy {"type":"number"} |
VersionFolder
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
name · required | {"type":"string"} |
items · required | {"type":"array","items":{"$ref":"VersionFolderItem"}} |
VersionIntent
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
name · required | {"type":"string"} |
slots | {"type":"array","items":{"$ref":"VersionIntentSlot"}} |
inputs · required | {"type":"array","items":{"$ref":"VersionIntentInput"}} |
noteID | {"type":"string"} |
description | {"type":"string"} |
VersionIntentInput
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"type":"string"} |
slots | {"type":"array","items":{"type":"string"}} |
voice | {"type":"string"} |
VersionIntentSlot
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
dialog · required | {"$ref":"VersionIntentSlotDialog"} |
required · required | {"type":"boolean"} |
VersionIntentSlotDialog
{"type":"object"}
| Property | Definition |
|---|---|
prompt · required | {"type":"array","items":{}} |
confirm · required | {"type":"array","items":{}} |
utterances · required | {"type":"array","items":{"$ref":"VersionIntentInput"}} |
confirmEnabled · required | {"type":"boolean"} |
VersionKnowledgeBase
{"type":"object"}
| Property | Definition |
|---|---|
faqSets | {"type":"object","additionalProperties":{"$ref":"VersionKnowledgeBaseSetFaq"}} |
settings | {"allOf":[{"$ref":"KnowledgeBaseSettings"}]} |
documents | {"type":"object","additionalProperties":{"$ref":"KnowledgeBaseDocument"}} |
VersionKnowledgeBaseSetFaq
{"type":"object"}
| Property | Definition |
|---|---|
name | {"type":"string"} |
status | {"allOf":[{"$ref":"VersionKnowledgeBaseSetFaqStatus"}]} |
version | {"type":"number"} |
faqSetID | {"type":"string"} |
updatedAt | {"type":"string"} |
creatorID | {"type":"number"} |
VersionKnowledgeBaseSetFaqStatus
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type | {"type":"string"} |
VersionModel
{"type":"object"}
| Property | Definition |
|---|---|
modelID | {"type":"string"} |
VersionNote
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
type · required | {"type":"string"} |
text · required | {"type":"string"} |
meta | {"type":"object","additionalProperties":{}} |
mentions · required | {"type":"array","items":{"type":"number"}} |
VersionPlatformData
{"type":"object"}
| Property | Definition |
|---|---|
slots · required | {"type":"array","items":{"$ref":"VersionSlot"}} |
intents · required | {"type":"array","items":{"$ref":"VersionIntent"}} |
settings · required | {"$ref":"VersionPlatformSettings"} |
publishing · required | {"type":"object","additionalProperties":{}} |
VersionPlatformSettings
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
locales | {"type":"array","items":{"type":"string"}} |
deepgramASR | {"allOf":[{"$ref":"DeepgramASRSettings"}]} |
globalNoReply | {"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["static"],"x-enumNames":["STATIC"]},"delay":{"nullable":true,"type":"number"},"prompt":{"nullable":true},"enabled":{"type":"boolean"},"maxRetries":{"nullable":true,"type":"number"}}},{"type":"object","properties":{"type":{"type":"string","enum":["generative"],"x-enumNames":["GENERATIVE"]},"delay":{"nullable":true,"type":"number"},"prompt":{"$ref":"AIParams"},"enabled":{"type":"boolean"},"maxRetries":{"nullable":true,"type":"number"}},"required":["type","prompt"]}]} |
defaultVoice | {"nullable":true,"type":"string"} |
globalNoMatch | {"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["static"],"x-enumNames":["STATIC"]},"prompt":{"nullable":true}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","enum":["generative"],"x-enumNames":["GENERATIVE"]},"prompt":{"$ref":"AIParams"}},"required":["type","prompt"]}]} |
messageDelay | {"type":"object","properties":{"durationMilliseconds":{"type":"number"}},"required":["durationMilliseconds"]} |
defaultCanvasNodeVisibility | {"allOf":[{"$ref":"LegacyCanvasNodeVisibility"}]} |
VersionProgramResources
{"type":"object"}
| Property | Definition |
|---|---|
flows | {"type":"object","additionalProperties":{"$ref":"CompiledFlow"}} |
agents | {"type":"object","additionalProperties":{"$ref":"CompiledAgent"}} |
prompts | {"type":"object","additionalProperties":{"$ref":"CompiledPrompt"}} |
apiTools | {"type":"object","additionalProperties":{"$ref":"CompiledAPITool"}} |
messages · required | {"type":"object","additionalProperties":{"$ref":"CompiledMessage"}} |
globalCrew | {"allOf":[{"$ref":"VersionProgramResourcesGlobalCrew"}]} |
globalPrompts | {"nullable":true,"allOf":[{"$ref":"VersionProgramResourcesGlobalPrompts"}]} |
costControl | {"nullable":true,"allOf":[{"$ref":"VersionProgramResourcesCostControl"}]} |
secretNameToId | {"type":"object","additionalProperties":{"type":"string"}} |
mcpServers | {"type":"object","additionalProperties":{"$ref":"CompiledMcpServer"}} |
mcpServerTools | {"type":"object","additionalProperties":{"$ref":"CompiledMcpServerTool"}} |
integrationTools | {"type":"object","additionalProperties":{"$ref":"CompiledIntegrationTool"}} |
mcpIntegrationTools | {"type":"object","additionalProperties":{"$ref":"CompiledMcpIntegrationTool"}} |
VersionProgramResourcesCostControl
{"type":"object"}
| Property | Definition |
|---|---|
endMessage | {"nullable":true,"type":"string"} |
VersionProgramResourcesGlobalCrew
{"type":"object"}
| Property | Definition |
|---|---|
nodeID | {"nullable":true,"type":"string"} |
agentID · required | {"type":"string"} |
subFlows | {"nullable":true,"type":"array","items":{"$ref":"CompiledCrewNodeDataFlow"}} |
diagramID | {"nullable":true,"type":"string"} |
subAgents | {"nullable":true,"type":"array","items":{"$ref":"CompiledCrewNodeDataAgent"}} |
agentDescription | Use global agent description instead {"deprecated":true,"nullable":true,"type":"string"} |
VersionProgramResourcesGlobalPrompts
{"type":"object"}
| Property | Definition |
|---|---|
persona | {"nullable":true,"type":"string"} |
guidelines | {"nullable":true,"type":"string"} |
VersionPrototype
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type | {"type":"string"} |
data · required | {"$ref":"VersionPrototypeData"} |
model · required | {"$ref":"PrototypeModel"} |
context · required | {"$ref":"VersionPrototypeContext"} |
platform · required | {"type":"string"} |
settings · required | {"$ref":"VersionPrototypeSettings"} |
surveyorContext · required | {"$ref":"VersionPrototypeSurveyorContext"} |
VersionPrototypeButtonLayout
{"type":"string","enum":["stacked","carousel"],"x-enumNames":["STACKED","CAROUSEL"]}
VersionPrototypeContext
{"type":"object"}
| Property | Definition |
|---|---|
turn | {"type":"object","additionalProperties":{}} |
stack | {"type":"array","items":{"$ref":"VersionPrototypeStackFrame"}} |
storage | {"type":"object","additionalProperties":{}} |
variables | {"type":"object","additionalProperties":{}} |
VersionPrototypeData
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
locales · required | {"type":"array","items":{"type":"string"}} |
messageDelay | {"allOf":[{"$ref":"VersionPrototypeMessageDelay"}]} |
VersionPrototypeMessageDelay
{"type":"object"}
| Property | Definition |
|---|---|
durationMilliseconds · required | {"type":"number"} |
VersionPrototypeSettings
{"type":"object"}
| Property | Definition |
|---|---|
avatar | {"type":"string"} |
layout | {"type":"string"} |
buttons | {"allOf":[{"$ref":"VersionPrototypeButtonLayout"}]} |
password | {"type":"string"} |
brandColor | {"type":"string"} |
brandImage | {"type":"string"} |
hasPassword | {"type":"boolean"} |
hasBranding | {"type":"boolean"} |
buttonsOnly | {"type":"boolean"} |
variableStateID | {"nullable":true,"type":"string"} |
VersionPrototypeStackFrame
{"type":"object"}
| Property | Definition |
|---|---|
nodeID | {"nullable":true,"type":"string"} |
programID | {"nullable":true,"type":"string"} |
storage | {"type":"object","additionalProperties":{}} |
commands | {"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{}}} |
diagramID · required | {"type":"string"} |
variables | {"type":"object","additionalProperties":{}} |
VersionPrototypeSurveyorContext
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
platform · required | {"type":"string"} |
slotsMap · required | {"type":"object","additionalProperties":{"$ref":"PrototypeSlot"}} |
extraSlots · required | {"type":"array","items":{"$ref":"PrototypeSlot"}} |
cmsEntities | {"type":"object","additionalProperties":{"$ref":"CompiledEntity"}} |
extraIntents · required | {"type":"array","items":{"$ref":"PrototypeIntent"}} |
cmsVariables | {"type":"object","additionalProperties":{"$ref":"CompiledVariable"}} |
usedIntentsSet | {"type":"array","items":{"type":"string"}} |
functionDefinitions | {"type":"object","additionalProperties":{"$ref":"CompiledFunctionDefinition"}} |
referencedAgentsIDs | {"type":"array","items":{"type":"string"}} |
referencedPromptIDs | {"type":"array","items":{"type":"string"}} |
referencedAPIToolIDs | {"type":"array","items":{"type":"string"}} |
referencedResponseIDs | {"type":"array","items":{"type":"string"}} |
referencedIntegrationToolIDs | {"type":"array","items":{"type":"string"}} |
referencedMCPIntegrationToolIDs | {"type":"array","items":{"type":"string"}} |
usedFunctionsMap | {"type":"object","additionalProperties":{"type":"string"}} |
VersionSettings
{"type":"object"}
| Property | Definition |
|---|---|
ui | {"allOf":[{"$ref":"VersionSettingsUI"}]} |
llm | {"allOf":[{"$ref":"VersionSettingsLLM"}]} |
time | {"allOf":[{"$ref":"VersionSettingsTime"}]} |
voice | {"allOf":[{"$ref":"VersionSettingsVoice"}]} |
widget | {"allOf":[{"$ref":"WidgetSettings"}]} |
interfaceConfig | {"allOf":[{"$ref":"InterfaceConfig"}]} |
defaultWidget | {"allOf":[{"$ref":"VersionSettingsDefaultWidget"}]} |
memory | {"allOf":[{"$ref":"VersionSettingsMemory"}]} |
session | {"allOf":[{"$ref":"VersionSettingsSession"}]} |
security | {"allOf":[{"$ref":"VersionSettingsSecurity"}]} |
framework | {"allOf":[{"$ref":"VersionSettingsFramework"}]} |
analytics | {"allOf":[{"$ref":"VersionSettingsAnalytics"}]} |
costControl | {"allOf":[{"$ref":"VersionSettingsCostControl"}]} |
globalCrew | {"allOf":[{"$ref":"VersionSettingsGlobalCrew"}]} |
llmFallback | {"allOf":[{"$ref":"LLMFallbackSettings"}]} |
globalNoReply | {"allOf":[{"$ref":"VersionSettingsGlobalNoReply"}]} |
globalNoMatch | {"allOf":[{"$ref":"VersionSettingsGlobalNoMatch"}]} |
shareableLink | {"nullable":true,"allOf":[{"$ref":"VersionSettingsShareableLink"}]} |
automaticReprompt | {"allOf":[{"$ref":"VersionSettingsAutomaticReprompt"}]} |
intentClassification · required | {"$ref":"IntentClassificationSettings"} |
VersionSettingsAnalytics
{"type":"object"}
| Property | Definition |
|---|---|
estimatedSavings | {"allOf":[{"$ref":"VersionSettingsAnalyticsEstimatedSavings"}]} |
VersionSettingsAnalyticsEstimatedSavings
{"type":"object"}
| Property | Definition |
|---|---|
resolutionRate | {"allOf":[{"$ref":"VersionSettingsAnalyticsEstimatedSavingsValue"}]} |
deflectionRate | {"allOf":[{"$ref":"VersionSettingsAnalyticsEstimatedSavingsValue"}]} |
conversionRate | {"allOf":[{"$ref":"VersionSettingsAnalyticsEstimatedSavingsConversionValue"}]} |
VersionSettingsAnalyticsEstimatedSavingsConversionValue
{"type":"object"}
| Property | Definition |
|---|---|
dollars | {"type":"number"} |
criteria | {"type":"string"} |
VersionSettingsAnalyticsEstimatedSavingsValue
{"type":"object"}
| Property | Definition |
|---|---|
minutes | {"type":"number"} |
dollars | {"type":"number"} |
VersionSettingsAutomaticReprompt
{"type":"object"}
| Property | Definition |
|---|---|
params · required | {"allOf":[{"$ref":"AutomaticRepromptParams"}]} |
VersionSettingsCostControl
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
maxDollars · required | {"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":10000} |
endMessage · required | {"$ref":"Markup"} |
VersionSettingsDefaultWidget
{"type":"string","enum":["webchat","interface"],"x-enumNames":["WEBCHAT","INTERFACE"]}
VersionSettingsFramework
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"ProjectFramework"} |
agenticInitializeComponentID | {"default":null,"nullable":true,"type":"string"} |
conversationInitializeComponentID · required | {"type":"string"} |
VersionSettingsGlobalCrew
{"type":"object"}
| Property | Definition |
|---|---|
agentID · required | {"type":"string"} |
agentDescription | Should not be used, use global agent description instead {"deprecated":true,"nullable":true,"type":"string"} |
subFlows · required | {"type":"array","items":{"$ref":"CrewNodeDataFlow"}} |
subAgents · required | {"type":"array","items":{"$ref":"CrewNodeDataAgent"}} |
VersionSettingsGlobalNoMatch
{"oneOf":[{"$ref":"VersionSettingsGlobalNoMatchStatic"},{"$ref":"VersionSettingsGlobalNoMatchGenerative"}]}
VersionSettingsGlobalNoMatchGenerative
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["generative"],"x-enumNames":["GENERATIVE"]} |
settings · required | {"type":"object","properties":{"model":{"allOf":[{"$ref":"AIModel"}]},"system":{"type":"string"},"maxTokens":{"type":"number"},"temperature":{"type":"number"},"reasoningEffort":{"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]},"serviceTier":{"description":"The service tier to request from models that support it. `priority` is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level `priorityProcessing` setting applies.","nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]}}} |
VersionSettingsGlobalNoMatchStatic
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["static"],"x-enumNames":["STATIC"]} |
prompt · required | {"$ref":"Markup"} |
VersionSettingsGlobalNoReply
{"anyOf":[{"$ref":"VersionSettingsGlobalNoReplyStatic"},{"$ref":"VersionSettingsGlobalNoReplyGenerative"}]}
VersionSettingsGlobalNoReplyGenerative
{"type":"object"}
| Property | Definition |
|---|---|
delay · required | {"nullable":true,"type":"number"} |
enabled · required | {"type":"boolean"} |
maxRetries | {"type":"number"} |
type · required | {"type":"string","enum":["generative"],"x-enumNames":["GENERATIVE"]} |
settings · required | {"type":"object","properties":{"model":{"allOf":[{"$ref":"AIModel"}]},"system":{"type":"string"},"maxTokens":{"type":"number"},"temperature":{"type":"number"},"reasoningEffort":{"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]},"serviceTier":{"description":"The service tier to request from models that support it. `priority` is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level `priorityProcessing` setting applies.","nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]}}} |
VersionSettingsGlobalNoReplyStatic
{"type":"object"}
| Property | Definition |
|---|---|
delay · required | {"nullable":true,"type":"number"} |
enabled · required | {"type":"boolean"} |
maxRetries | {"type":"number"} |
type | {"type":"string","enum":["static"],"x-enumNames":["STATIC"]} |
prompt · required | {"$ref":"Markup"} |
VersionSettingsLLM
{"type":"object"}
| Property | Definition |
|---|---|
globalPrompts | {"type":"object","properties":{"persona":{"nullable":true,"allOf":[{"$ref":"Markup"}]},"guidelines":{"nullable":true,"allOf":[{"$ref":"Markup"}]}}} |
defaultModels | {"type":"object","properties":{"global":{"type":"object","properties":{"model":{"allOf":[{"$ref":"AIModel"}]},"maxTokens":{"type":"number"},"temperature":{"type":"number"},"reasoningEffort":{"nullable":true,"allOf":[{"$ref":"AIReasoningEffort"}]},"serviceTier":{"description":"The service tier to request from models that support it. `priority` is faster processing: faster responses at a higher credit cost. When unset, the deprecated project-level `priorityProcessing` setting applies.","nullable":true,"allOf":[{"$ref":"AIParamsServiceTier"}]}}}}} |
globalAgentID | @deprecated Use globalCrew.agentID instead {"type":"string"} |
priorityProcessing | @deprecated Faster processing is set per model: use {"type":"boolean"} |
VersionSettingsMemory
{"type":"object"}
| Property | Definition |
|---|---|
turns | {"default":10,"type":"number"} |
VersionSettingsSecurity
{"type":"object"}
| Property | Definition |
|---|---|
transcriptsPII | {"default":false,"type":"boolean"} |
VersionSettingsSession
{"type":"object"}
| Property | Definition |
|---|---|
idleTimeout · required | {"$ref":"VersionSettingsSessionIdleTimeout"} |
VersionSettingsSessionIdleTimeout
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
timeoutMs · required | {"type":"number"} |
VersionSettingsShareableLink
{"type":"object"}
| Property | Definition |
|---|---|
password | {"type":"string"} |
variableStateID | {"nullable":true,"type":"string"} |
VersionSettingsTime
{"type":"object"}
| Property | Definition |
|---|---|
timezone | {"nullable":true,"allOf":[{"$ref":"Timezone"}]} |
injectInAgent | {"type":"boolean"} |
VersionSettingsUI
{"type":"object"}
| Property | Definition |
|---|---|
transcripts | {"allOf":[{"$ref":"VersionSettingsUITranscripts"}]} |
analytics | {"allOf":[{"$ref":"VersionSettingsUIAnalytics"}]} |
VersionSettingsUIAnalytics / VersionSettingsUITranscripts
{"type":"object"}
| Property | Definition |
|---|---|
sectionsOrderIDs | {"type":"array","items":{"type":"string"}} |
VersionSettingsVoice
{"type":"object"}
| Property | Definition |
|---|---|
stt | {"allOf":[{"$ref":"STTSettings"}]} |
tts | {"allOf":[{"$ref":"VoiceSettings"}]} |
localeOverrides | {"type":"array","items":{"$ref":"VoiceLocaleOverride"}} |
pronunciationDictionary | {"maxItems":500,"type":"array","items":{"$ref":"PronunciationDictionaryEntry"}} |
failureMessage | {"nullable":true,"type":"string"} |
hasCallRecording | {"default":true,"type":"boolean"} |
hasProviderCallRecording | {"type":"boolean"} |
audioCue | {"nullable":true,"type":"number"} |
backgroundAudio | {"nullable":true,"type":"string"} |
backgroundAudioSettings | {"allOf":[{"$ref":"BackgroundAudioSettings"}]} |
audioSync | {"type":"boolean"} |
keypadInput | {"allOf":[{"$ref":"VoiceKeypadSettings"}]} |
silenceTimeoutMs | {"type":"number"} |
maxDuration | {"allOf":[{"$ref":"VoiceMaxDurationSettings"}]} |
callerIdentity | {"allOf":[{"$ref":"VersionSettingsVoiceCallerIdentity"}]} |
VersionSettingsVoiceCallerIdentity
{"type":"string","enum":["phone-number","call"],"x-enumNames":["PHONE_NUMBER","CALL"]}
VersionSlot
{"type":"object"}
| Property | Definition |
|---|---|
key · required | {"type":"string"} |
name · required | {"type":"string"} |
type · required | {"$ref":"VersionSlotType"} |
color | {"type":"string"} |
inputs · required | {"type":"array","items":{"type":"string"}} |
VersionSlotType
{"type":"object"}
| Property | Definition |
|---|---|
value | {"type":"string"} |
VoiceKeypadSettings
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
delimiter · required | {"maxItems":2,"type":"array","items":{"$ref":"DTMFDelimiter"}} |
timeoutInSeconds · required | {"type":"number"} |
VoiceLocaleOverride
{"type":"object"}
| Property | Definition |
|---|---|
locale · required | {"type":"string","minLength":1} |
tts · required | {"$ref":"VoiceSettings"} |
VoiceMaxDurationSettings
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
seconds · required | {"nullable":true,"type":"number"} |
message · required | {"nullable":true,"type":"string"} |
VoiceSettings
{"oneOf":[{"$ref":"AmazonVoiceSettings"},{"$ref":"GoogleVoiceSettings"},{"$ref":"CartesiaVoiceSettings"},{"$ref":"RimelabsVoiceSettings"},{"$ref":"SonioxVoiceSettings"},{"$ref":"MicrosoftVoiceSettings"},{"$ref":"ElevenLabsVoiceSettings"}]}
WidgetSettings
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"WidgetSettingsWidgetType"} |
chat · required | {"$ref":"WidgetSettingsChatSettings"} |
voice · required | {"$ref":"WidgetSettingsVoiceSettings"} |
common · required | {"$ref":"WidgetSettingsCommonSettings"} |
security | {"allOf":[{"$ref":"WidgetSettingsSecuritySettings"}]} |
WidgetSettingsChatDisclaimer
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
title · required | {"type":"string"} |
description · required | {"type":"string"} |
primaryButtonText · required | {"type":"string"} |
secondaryButtonText · required | {"type":"string"} |
secondaryButtonURL · required | {"type":"string"} |
WidgetSettingsChatPersistence
{"type":"string","enum":["memory","localStorage","sessionStorage"],"x-enumNames":["MEMORY","LOCAL_STORAGE","SESSION_STORAGE"]}
WidgetSettingsChatRenderMode
{"type":"string","enum":["embed","widget","popover"],"x-enumNames":["EMBED","WIDGET","POPOVER"]}
WidgetSettingsChatSettings
{"type":"object"}
| Property | Definition |
|---|---|
renderMode · required | {"$ref":"WidgetSettingsChatRenderMode"} |
headerImage · required | {"$ref":"WidgetSettingsChatSettingsHeaderImage"} |
agentImage · required | {"$ref":"WidgetSettingsChatSettingsAgentImage"} |
banner · required | {"$ref":"WidgetSettingsChatSettingsBanner"} |
placeholderText · required | {"type":"string"} |
disclaimer | {"allOf":[{"$ref":"WidgetSettingsChatDisclaimer"}]} |
aiDisclaimer · required | {"$ref":"WidgetSettingsChatSettingsAIDisclaimer"} |
handoffToAgentImageURL | {"nullable":true,"type":"string"} |
streamingDisabled | {"type":"boolean"} |
responseLoader | {"allOf":[{"$ref":"WidgetSettingsChatSettingsResponseLoader"}]} |
voiceInput · required | {"type":"boolean"} |
voiceOutput · required | {"type":"boolean"} |
voiceOutputMuted | {"type":"boolean"} |
voiceMode | {"type":"boolean"} |
notificationSound | {"type":"boolean"} |
fileUpload | {"allOf":[{"$ref":"WidgetSettingsChatSettingsFileUpload"}]} |
csat | {"allOf":[{"$ref":"WidgetSettingsChatSettingsCSAT"}]} |
WidgetSettingsChatSettingsAIDisclaimer
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"type":"string"} |
enabled · required | {"type":"boolean"} |
WidgetSettingsChatSettingsAgentImage / WidgetSettingsChatSettingsHeaderImage
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
url | {"nullable":true,"type":"string"} |
WidgetSettingsChatSettingsBanner
{"type":"object"}
| Property | Definition |
|---|---|
title · required | {"type":"string"} |
description · required | {"type":"string"} |
enabled · required | {"type":"boolean"} |
imageURL | {"nullable":true,"type":"string"} |
WidgetSettingsChatSettingsCSAT
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
promptText | {"type":"string"} |
includeFreetextFeedback · required | {"type":"boolean"} |
WidgetSettingsChatSettingsFileUpload
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
maxFilesPerConversation | {"nullable":true,"type":"number"} |
model | {"type":"string"} |
WidgetSettingsChatSettingsResponseLoader
{"oneOf":[{"$ref":"WidgetSettingsChatSettingsResponseLoaderDots"},{"$ref":"WidgetSettingsChatSettingsResponseLoaderSpinnerWithText"}]}
WidgetSettingsChatSettingsResponseLoaderDots
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dots"],"x-enumNames":["DOTS"]} |
WidgetSettingsChatSettingsResponseLoaderSpinnerWithText
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["spinner-with-text"],"x-enumNames":["SPINNER_WITH_TEXT"]} |
text · required | {"type":"string"} |
WidgetSettingsCommonSettings
{"type":"object"}
| Property | Definition |
|---|---|
sideSpacing · required | {"type":"string"} |
bottomSpacing · required | {"type":"string"} |
width | {"type":"string"} |
position · required | {"$ref":"WidgetSettingsWidgetPosition"} |
fontFamily · required | {"type":"string"} |
primaryColor · required | {"$ref":"WidgetSettingsPrimaryColor"} |
poweredBy · required | {"type":"boolean"} |
launcher · required | {"$ref":"WidgetSettingsCommonSettingsLauncher"} |
footerLink · required | {"$ref":"WidgetSettingsCommonSettingsFooterLink"} |
persistence · required | {"$ref":"WidgetSettingsChatPersistence"} |
featureFlags | {"allOf":[{"$ref":"WidgetSettingsCommonSettingsFeatureFlags"}]} |
WidgetSettingsCommonSettingsFeatureFlags
{"type":"object","additionalProperties":{"type":"boolean"}}
WidgetSettingsCommonSettingsFooterLink
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
text | {"type":"string"} |
url | {"type":"string"} |
WidgetSettingsCommonSettingsLauncher
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"WidgetSettingsLauncherType"} |
text | {"type":"string"} |
imageURL | {"nullable":true,"type":"string"} |
WidgetSettingsLauncherType
{"type":"string","enum":["icon","label","both"],"x-enumNames":["ICON","LABEL","BOTH"]}
WidgetSettingsPrimaryColor
{"type":"object"}
| Property | Definition |
|---|---|
color · required | {"type":"string"} |
palette · required | {"$ref":"WidgetSettingsColorPalette"} |
WidgetSettingsSecuritySettings
{"type":"object"}
| Property | Definition |
|---|---|
approvedDomains · required | {"$ref":"WidgetSettingsSecuritySettingsApprovedDomains"} |
disableTranscript · required | {"type":"boolean"} |
isTranscriptDownloadEnabled | {"type":"boolean"} |
WidgetSettingsSecuritySettingsApprovedDomains
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
domains · required | {"type":"string"} |
WidgetSettingsVoiceRenderMode
{"type":"string","enum":["full","compact","expand"],"x-enumNames":["FULL","COMPACT","EXPAND"]}
WidgetSettingsVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
renderMode · required | {"$ref":"WidgetSettingsVoiceRenderMode"} |
content · required | {"$ref":"WidgetSettingsVoiceSettingsContent"} |
WidgetSettingsVoiceSettingsContent
{"type":"object"}
| Property | Definition |
|---|---|
imageURL | {"nullable":true,"type":"string"} |
talkingText · required | {"type":"string"} |
endButtonText · required | {"type":"string"} |
listeningText · required | {"type":"string"} |
startButtonText · required | {"type":"string"} |
callToActionText · required | {"type":"string"} |
WidgetSettingsWidgetPosition
{"type":"string","enum":["right","left"],"x-enumNames":["RIGHT","LEFT"]}
WidgetSettingsWidgetType
{"type":"string","enum":["chat","voice"],"x-enumNames":["CHAT","VOICE"]}
Workflow
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
createdAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedAt · required | {"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"} |
updatedByID · required | {"type":"number"} |
assistantID | {"type":"string"} |
environmentID | {"type":"string"} |
folderID · required | {"nullable":true,"type":"string"} |
createdByID · required | {"type":"number"} |
status · required | {"nullable":true,"allOf":[{"$ref":"WorkflowStatus"}]} |
name · required | {"type":"string","minLength":1,"maxLength":255} |
isStart · required | {"type":"boolean"} |
diagramID · required | {"type":"string"} |
assigneeID · required | {"nullable":true,"type":"number"} |
description · required | {"nullable":true,"type":"string"} |
WorkflowStatus
{"type":"string","enum":["to_do","complete","in_progress"],"x-enumNames":["TO_DO","COMPLETE","IN_PROGRESS"]}
Was this page helpful?
Thanks for your feedback.