> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Agents

API operations for agents. Browse the routes below for parameters, request examples, and responses.

API version: Selected per operation

## Get agent

Returns the environment's agent: the global prompt, the instructions that route a turn, and the settings wrapping both. The prompt and instructions are plain Markdown strings, and each entry in the agent's playbook and workflow lists can carry a condition.

### Endpoint

```http
GET /v2/stable/agent
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `includeInstructions`

Optional · boolean

Instructions can be tens of thousands of lines. Leave this off and use read_instructions to page through them only when you need the text.

```json
{
  "default": false,
  "description": "Instructions can be tens of thousands of lines. Leave this off and use read_instructions to page through them only when you need the text.",
  "type": "boolean"
}
```

#### `includePrompt`

Optional · boolean

The global prompt can be tens of thousands of lines. Leave this off and use read_prompt to page through it only when you need the text.

```json
{
  "default": false,
  "description": "The global prompt can be tens of thousands of lines. Leave this off and use read_prompt to page through it only when you need the text.",
  "type": "boolean"
}
```

### Responses

#### 200

Returns the agent's whole configuration: its model settings, prompt, instructions, the playbooks and workflows attached to it, and its system tool setup. The voice section is optional and may be absent.

Schema:

```json
{
  "$ref": "#/components/schemas/StableAgentResponseV2"
}
```

Example:

```json
{
  "agent": {
    "llm": {
      "priorityProcessing": true,
      "defaults": {
        "model": "<AIModel>",
        "maxTokens": 0,
        "temperature": 0,
        "reasoningEffort": "<AIReasoningEffort>",
        "serviceTier": "<AIParamsServiceTier>"
      }
    },
    "prompt": "<string>",
    "includeGuidelines": true,
    "voice": {
      "stt": "<STTSettings>",
      "tts": "<VoiceSettings>",
      "localeOverrides": [
        "<VoiceLocaleOverride>"
      ],
      "pronunciationDictionary": [
        "<PronunciationDictionaryEntry>"
      ],
      "failureMessage": "<string>",
      "hasCallRecording": true,
      "hasProviderCallRecording": true,
      "audioCue": 0,
      "backgroundAudio": "<string>",
      "backgroundAudioSettings": "<BackgroundAudioSettings>",
      "audioSync": true,
      "keypadInput": "<VoiceKeypadSettings>",
      "silenceTimeoutMs": 0,
      "maxDuration": "<VoiceMaxDurationSettings>",
      "callerIdentity": "<VersionSettingsVoiceCallerIdentity>"
    },
    "playbooks": [
      {
        "condition": "<StableExpressionCondition>",
        "description": "<string>",
        "requiredVariables": [
          "<CrewNodeDataRequiredVariable>"
        ],
        "playbookID": "<string>"
      }
    ],
    "workflows": [
      {
        "condition": "<StableExpressionCondition>",
        "description": "<string>",
        "requiredVariables": [
          "<CrewNodeDataRequiredVariable>"
        ],
        "workflowID": "<string>"
      }
    ],
    "endTool": {
      "enabled": true,
      "messages": null,
      "toolSound": null,
      "description": "<string>"
    },
    "cardTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "buttonTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "carouselTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "webSearchTool": {
      "enabled": true,
      "messages": null,
      "toolSound": null,
      "description": "<string>",
      "allowedDomains": [
        "<string>"
      ],
      "sourceUrlsCount": 0
    },
    "callForwardTool": {
      "enabled": true,
      "address": "<VariableReferenceString>",
      "messages": null,
      "extension": "<VariableReferenceString>",
      "toolSound": null,
      "description": "<string>",
      "addressType": "<CallForwardAddressType>",
      "callerIDPassthrough": true
    },
    "knowledgeBaseTool": {
      "query": "<VariableReferenceString>",
      "enabled": true,
      "filters": [
        "<StableKBFilter>"
      ],
      "messages": null,
      "toolSound": null,
      "chunkLimit": 0,
      "description": "<string>",
      "queryMode": "<AgentKnowledgeBaseToolQueryMode>",
      "sourceUrlsCount": 0
    },
    "instructions": "<string>",
    "skipTurnTool": {
      "enabled": true,
      "description": "<string>"
    },
    "pathToolOrder": [
      "<string>"
    ],
    "promptLineCount": 0,
    "instructionsLineCount": 0
  }
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent get --project-id <projectID> --environment-alias <environmentAlias> --include-instructions <includeInstructions> --include-prompt <includePrompt>
```


## Update agent

Changes the agent that shapes every turn - its global prompt, its routing instructions, or its settings - in the environment named by the request. The prompt and instructions are sent as plain Markdown strings.

### Endpoint

```http
PATCH /v2/stable/agent
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StableAgentUpdateRequestV2"
          }
        ]
      }
    }
  }
}
```

### Responses

#### 200

Confirms the agent's configuration was updated, and lists any references or mentions in the new text that did not resolve. The body is a message rather than the new configuration, so read the agent back to see what it holds now.

Schema:

```json
{
  "$ref": "#/components/schemas/StableMarkdownUpdateResponse"
}
```

Example:

```json
{
  "message": "<string>",
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ],
  "unresolvedMentions": [
    {
      "path": "<string>",
      "mention": "<string>"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "<string>",
  "endTool": {
    "enabled": true,
    "messages": null,
    "toolSound": null,
    "description": "<string>"
  },
  "cardTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "playbooks": [
    {
      "condition": "<StableExpressionCondition>",
      "description": "<string>",
      "requiredVariables": [
        "<StableRoutingRequiredVariableInput>"
      ],
      "playbookID": "<string>"
    }
  ],
  "workflows": [
    {
      "condition": "<StableExpressionCondition>",
      "description": "<string>",
      "requiredVariables": [
        "<StableRoutingRequiredVariableInput>"
      ],
      "workflowID": "<string>"
    }
  ],
  "buttonTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "carouselTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "instructions": "<string>",
  "skipTurnTool": {
    "enabled": true,
    "description": "<string>"
  },
  "pathToolOrder": [
    "<string>"
  ],
  "webSearchTool": {
    "enabled": true,
    "messages": null,
    "toolSound": null,
    "description": "<string>",
    "allowedDomains": [
      "<string>"
    ],
    "sourceUrlsCount": 0
  },
  "callForwardTool": {
    "enabled": true,
    "address": "<VariableReferenceString>",
    "messages": null,
    "extension": "<VariableReferenceString>",
    "toolSound": null,
    "description": "<string>",
    "addressType": "<CallForwardAddressType>",
    "callerIDPassthrough": true
  },
  "knowledgeBaseTool": {
    "query": "<VariableReferenceString>",
    "enabled": true,
    "filters": [
      "<StableKBFilter>"
    ],
    "messages": null,
    "toolSound": null,
    "chunkLimit": 0,
    "description": "<string>",
    "queryMode": "<AgentKnowledgeBaseToolQueryMode>",
    "sourceUrlsCount": 0
  },
  "includeGuidelines": true,
  "llm": {
    "priorityProcessing": true,
    "defaults": {
      "model": "<AIModel>",
      "maxTokens": 0,
      "temperature": 0,
      "reasoningEffort": "<AIReasoningEffort>",
      "serviceTier": "<AIParamsServiceTier>"
    }
  },
  "voice": {
    "stt": "<STTSettings>",
    "tts": "<VoiceSettings>",
    "localeOverrides": [
      "<VoiceLocaleOverride>"
    ],
    "pronunciationDictionary": [
      "<PronunciationDictionaryEntry>"
    ],
    "failureMessage": "<string>",
    "hasCallRecording": true,
    "hasProviderCallRecording": true,
    "audioCue": 0,
    "backgroundAudio": "<string>",
    "backgroundAudioSettings": "<BackgroundAudioSettings>",
    "audioSync": true,
    "keypadInput": "<VoiceKeypadSettings>",
    "silenceTimeoutMs": 0,
    "maxDuration": "<VoiceMaxDurationSettings>",
    "callerIdentity": "<VersionSettingsVoiceCallerIdentity>"
  }
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "prompt": "<string>",
    "endTool": {
      "enabled": true,
      "messages": null,
      "toolSound": null,
      "description": "<string>"
    },
    "cardTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "playbooks": [
      {
        "condition": "<StableExpressionCondition>",
        "description": "<string>",
        "requiredVariables": [
          "<StableRoutingRequiredVariableInput>"
        ],
        "playbookID": "<string>"
      }
    ],
    "workflows": [
      {
        "condition": "<StableExpressionCondition>",
        "description": "<string>",
        "requiredVariables": [
          "<StableRoutingRequiredVariableInput>"
        ],
        "workflowID": "<string>"
      }
    ],
    "buttonTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "carouselTool": {
      "enabled": true,
      "messages": null,
      "description": "<string>"
    },
    "instructions": "<string>",
    "skipTurnTool": {
      "enabled": true,
      "description": "<string>"
    },
    "pathToolOrder": [
      "<string>"
    ],
    "webSearchTool": {
      "enabled": true,
      "messages": null,
      "toolSound": null,
      "description": "<string>",
      "allowedDomains": [
        "<string>"
      ],
      "sourceUrlsCount": 0
    },
    "callForwardTool": {
      "enabled": true,
      "address": "<VariableReferenceString>",
      "messages": null,
      "extension": "<VariableReferenceString>",
      "toolSound": null,
      "description": "<string>",
      "addressType": "<CallForwardAddressType>",
      "callerIDPassthrough": true
    },
    "knowledgeBaseTool": {
      "query": "<VariableReferenceString>",
      "enabled": true,
      "filters": [
        "<StableKBFilter>"
      ],
      "messages": null,
      "toolSound": null,
      "chunkLimit": 0,
      "description": "<string>",
      "queryMode": "<AgentKnowledgeBaseToolQueryMode>",
      "sourceUrlsCount": 0
    },
    "includeGuidelines": true,
    "llm": {
      "priorityProcessing": true,
      "defaults": {
        "model": "<AIModel>",
        "maxTokens": 0,
        "temperature": 0,
        "reasoningEffort": "<AIReasoningEffort>",
        "serviceTier": "<AIParamsServiceTier>"
      }
    },
    "voice": {
      "stt": "<STTSettings>",
      "tts": "<VoiceSettings>",
      "localeOverrides": [
        "<VoiceLocaleOverride>"
      ],
      "pronunciationDictionary": [
        "<PronunciationDictionaryEntry>"
      ],
      "failureMessage": "<string>",
      "hasCallRecording": true,
      "hasProviderCallRecording": true,
      "audioCue": 0,
      "backgroundAudio": "<string>",
      "backgroundAudioSettings": "<BackgroundAudioSettings>",
      "audioSync": true,
      "keypadInput": "<VoiceKeypadSettings>",
      "silenceTimeoutMs": 0,
      "maxDuration": "<VoiceMaxDurationSettings>",
      "callerIdentity": "<VersionSettingsVoiceCallerIdentity>"
    }
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v2/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "prompt": "<string>",
      "endTool": {
        "enabled": True,
        "messages": None,
        "toolSound": None,
        "description": "<string>"
      },
      "cardTool": {
        "enabled": True,
        "messages": None,
        "description": "<string>"
      },
      "playbooks": [
        {
          "condition": "<StableExpressionCondition>",
          "description": "<string>",
          "requiredVariables": [
            "<StableRoutingRequiredVariableInput>"
          ],
          "playbookID": "<string>"
        }
      ],
      "workflows": [
        {
          "condition": "<StableExpressionCondition>",
          "description": "<string>",
          "requiredVariables": [
            "<StableRoutingRequiredVariableInput>"
          ],
          "workflowID": "<string>"
        }
      ],
      "buttonTool": {
        "enabled": True,
        "messages": None,
        "description": "<string>"
      },
      "carouselTool": {
        "enabled": True,
        "messages": None,
        "description": "<string>"
      },
      "instructions": "<string>",
      "skipTurnTool": {
        "enabled": True,
        "description": "<string>"
      },
      "pathToolOrder": [
        "<string>"
      ],
      "webSearchTool": {
        "enabled": True,
        "messages": None,
        "toolSound": None,
        "description": "<string>",
        "allowedDomains": [
          "<string>"
        ],
        "sourceUrlsCount": 0
      },
      "callForwardTool": {
        "enabled": True,
        "address": "<VariableReferenceString>",
        "messages": None,
        "extension": "<VariableReferenceString>",
        "toolSound": None,
        "description": "<string>",
        "addressType": "<CallForwardAddressType>",
        "callerIDPassthrough": True
      },
      "knowledgeBaseTool": {
        "query": "<VariableReferenceString>",
        "enabled": True,
        "filters": [
          "<StableKBFilter>"
        ],
        "messages": None,
        "toolSound": None,
        "chunkLimit": 0,
        "description": "<string>",
        "queryMode": "<AgentKnowledgeBaseToolQueryMode>",
        "sourceUrlsCount": 0
      },
      "includeGuidelines": True,
      "llm": {
        "priorityProcessing": True,
        "defaults": {
          "model": "<AIModel>",
          "maxTokens": 0,
          "temperature": 0,
          "reasoningEffort": "<AIReasoningEffort>",
          "serviceTier": "<AIParamsServiceTier>"
        }
      },
      "voice": {
        "stt": "<STTSettings>",
        "tts": "<VoiceSettings>",
        "localeOverrides": [
          "<VoiceLocaleOverride>"
        ],
        "pronunciationDictionary": [
          "<PronunciationDictionaryEntry>"
        ],
        "failureMessage": "<string>",
        "hasCallRecording": True,
        "hasProviderCallRecording": True,
        "audioCue": 0,
        "backgroundAudio": "<string>",
        "backgroundAudioSettings": "<BackgroundAudioSettings>",
        "audioSync": True,
        "keypadInput": "<VoiceKeypadSettings>",
        "silenceTimeoutMs": 0,
        "maxDuration": "<VoiceMaxDurationSettings>",
        "callerIdentity": "<VersionSettingsVoiceCallerIdentity>"
      }
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent update --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "prompt": "<string>",
  "endTool": {
    "enabled": true,
    "messages": null,
    "toolSound": null,
    "description": "<string>"
  },
  "cardTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "playbooks": [
    {
      "condition": "<StableExpressionCondition>",
      "description": "<string>",
      "requiredVariables": [
        "<StableRoutingRequiredVariableInput>"
      ],
      "playbookID": "<string>"
    }
  ],
  "workflows": [
    {
      "condition": "<StableExpressionCondition>",
      "description": "<string>",
      "requiredVariables": [
        "<StableRoutingRequiredVariableInput>"
      ],
      "workflowID": "<string>"
    }
  ],
  "buttonTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "carouselTool": {
    "enabled": true,
    "messages": null,
    "description": "<string>"
  },
  "instructions": "<string>",
  "skipTurnTool": {
    "enabled": true,
    "description": "<string>"
  },
  "pathToolOrder": [
    "<string>"
  ],
  "webSearchTool": {
    "enabled": true,
    "messages": null,
    "toolSound": null,
    "description": "<string>",
    "allowedDomains": [
      "<string>"
    ],
    "sourceUrlsCount": 0
  },
  "callForwardTool": {
    "enabled": true,
    "address": "<VariableReferenceString>",
    "messages": null,
    "extension": "<VariableReferenceString>",
    "toolSound": null,
    "description": "<string>",
    "addressType": "<CallForwardAddressType>",
    "callerIDPassthrough": true
  },
  "knowledgeBaseTool": {
    "query": "<VariableReferenceString>",
    "enabled": true,
    "filters": [
      "<StableKBFilter>"
    ],
    "messages": null,
    "toolSound": null,
    "chunkLimit": 0,
    "description": "<string>",
    "queryMode": "<AgentKnowledgeBaseToolQueryMode>",
    "sourceUrlsCount": 0
  },
  "includeGuidelines": true,
  "llm": {
    "priorityProcessing": true,
    "defaults": {
      "model": "<AIModel>",
      "maxTokens": 0,
      "temperature": 0,
      "reasoningEffort": "<AIReasoningEffort>",
      "serviceTier": "<AIParamsServiceTier>"
    }
  },
  "voice": {
    "stt": "<STTSettings>",
    "tts": "<VoiceSettings>",
    "localeOverrides": [
      "<VoiceLocaleOverride>"
    ],
    "pronunciationDictionary": [
      "<PronunciationDictionaryEntry>"
    ],
    "failureMessage": "<string>",
    "hasCallRecording": true,
    "hasProviderCallRecording": true,
    "audioCue": 0,
    "backgroundAudio": "<string>",
    "backgroundAudioSettings": "<BackgroundAudioSettings>",
    "audioSync": true,
    "keypadInput": "<VoiceKeypadSettings>",
    "silenceTimeoutMs": 0,
    "maxDuration": "<VoiceMaxDurationSettings>",
    "callerIdentity": "<VersionSettingsVoiceCallerIdentity>"
  }
}
JSON
```


## Read agent instructions

Returns one page of the main agent's routing instructions, each line prefixed with its 1-based number, so a later patch can quote text exactly as it appears. `offset` and `limit` pick the page; the totals in the response cover the whole document.

### Endpoint

```http
GET /v2/stable/agent/instructions
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `offset`

Optional · integer

The 1-based line number to start from. Clamped to the last line of the document.

```json
{
  "default": 1,
  "description": "The 1-based line number to start from. Clamped to the last line of the document.",
  "type": "integer",
  "minimum": 1,
  "maximum": 9007199254740991
}
```

#### `limit`

Optional · integer

The maximum number of lines to return. A page is also capped at 24,000 characters, so a page of very long lines can come back shorter than this — follow nextOffset while hasMore is true.

```json
{
  "default": 400,
  "description": "The maximum number of lines to return. A page is also capped at 24,000 characters, so a page of very long lines can come back shorter than this — follow nextOffset while hasMore is true.",
  "type": "integer",
  "minimum": 1,
  "maximum": 2000
}
```

### Responses

#### 200

Returns the requested lines of the main agent's instructions as one numbered block, with the page's actual offset, its line count, the document's total lines and characters, and whether more lines follow.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsReadResponseV2"
}
```

Example:

```json
{
  "content": "<string>",
  "offset": 0,
  "returnedLines": 0,
  "totalLines": 0,
  "totalCharacters": 0,
  "hasMore": true,
  "nextOffset": 0,
  "note": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent read-instructions --project-id <projectID> --environment-alias <environmentAlias> --offset <offset> --limit <limit>
```


## Patch agent instructions

Replaces one exact string in the main agent's routing instructions with another, matching literally on whitespace, punctuation and case. Quote `oldString` from a read or search result; with `replaceAll` off, more than one match is an error rather than a guess.

### Endpoint

```http
PATCH /v2/stable/agent/instructions
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableInstructionsPatchRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns how many occurrences were replaced in the main agent's instructions, a unified diff of the changed lines, the document's line count after the write, and any references or mentions the new text left unresolved.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsPatchResponseV2"
}
```

Example:

```json
{
  "message": "<string>",
  "replacements": 0,
  "diff": "<string>",
  "totalLines": 0,
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ],
  "unresolvedMentions": [
    {
      "path": "<string>",
      "mention": "<string>"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "oldString": "<string>",
  "newString": "<string>",
  "replaceAll": false
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "oldString": "<string>",
    "newString": "<string>",
    "replaceAll": false
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v2/stable/agent/instructions?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "oldString": "<string>",
      "newString": "<string>",
      "replaceAll": False
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent patch-instructions --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "oldString": "<string>",
  "newString": "<string>",
  "replaceAll": false
}
JSON
```


## Search agent instructions

Searches the main agent's routing instructions line by line with a JavaScript regular expression and returns one page of matching lines with surrounding context, up to `limit`; the match totals count the whole document.

### Endpoint

```http
POST /v2/stable/agent/instructions/search
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableInstructionsSearchRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns the matching lines of the main agent's instructions, each with its line number, hit count and context lines, plus the total matches and matching lines across the whole document and whether the limit cut the list short.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsSearchResponse"
}
```

Example:

```json
{
  "matches": [
    {
      "line": 0,
      "count": 0,
      "before": [
        "<string>"
      ],
      "text": "<string>",
      "after": [
        "<string>"
      ]
    }
  ],
  "totalMatches": 0,
  "matchingLines": 0,
  "hasMore": true
}
```

### Request examples

#### cURL

```bash
curl --request POST \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/instructions/search?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pattern": "<string>",
  "ignoreCase": false,
  "contextLines": 0,
  "limit": 50
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/instructions/search?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "pattern": "<string>",
    "ignoreCase": false,
    "contextLines": 0,
    "limit": 50
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v2/stable/agent/instructions/search?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "pattern": "<string>",
      "ignoreCase": False,
      "contextLines": 0,
      "limit": 50
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent search-instructions --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "pattern": "<string>",
  "ignoreCase": false,
  "contextLines": 0,
  "limit": 50
}
JSON
```


## Read the global prompt

Returns one page of the global prompt, each line prefixed with its 1-based number, so a later patch can quote text exactly as it appears. `offset` and `limit` pick the page; the totals in the response cover the whole prompt.

### Endpoint

```http
GET /v2/stable/agent/prompt
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `offset`

Optional · integer

The 1-based line number to start from. Clamped to the last line of the document.

```json
{
  "default": 1,
  "description": "The 1-based line number to start from. Clamped to the last line of the document.",
  "type": "integer",
  "minimum": 1,
  "maximum": 9007199254740991
}
```

#### `limit`

Optional · integer

The maximum number of lines to return. A page is also capped at 24,000 characters, so a page of very long lines can come back shorter than this — follow nextOffset while hasMore is true.

```json
{
  "default": 400,
  "description": "The maximum number of lines to return. A page is also capped at 24,000 characters, so a page of very long lines can come back shorter than this — follow nextOffset while hasMore is true.",
  "type": "integer",
  "minimum": 1,
  "maximum": 2000
}
```

### Responses

#### 200

Returns the requested lines of the global prompt as one numbered block, with the page's actual offset, its line count, the prompt's total lines and characters, and whether more lines follow.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsReadResponseV2"
}
```

Example:

```json
{
  "content": "<string>",
  "offset": 0,
  "returnedLines": 0,
  "totalLines": 0,
  "totalCharacters": 0,
  "hasMore": true,
  "nextOffset": 0,
  "note": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>&offset=<offset>&limit=<limit>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent read-prompt --project-id <projectID> --environment-alias <environmentAlias> --offset <offset> --limit <limit>
```


## Patch the global prompt

Replaces one exact string in the global prompt with another, matching literally on whitespace, punctuation and case. Quote `oldString` from a read or search result; with `replaceAll` off, more than one match is an error rather than a guess.

### Endpoint

```http
PATCH /v2/stable/agent/prompt
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableInstructionsPatchRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns how many occurrences were replaced in the global prompt, a unified diff of the changed lines, the prompt's line count after the write, and any references or mentions the new text left unresolved.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsPatchResponseV2"
}
```

Example:

```json
{
  "message": "<string>",
  "replacements": 0,
  "diff": "<string>",
  "totalLines": 0,
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ],
  "unresolvedMentions": [
    {
      "path": "<string>",
      "mention": "<string>"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "oldString": "<string>",
  "newString": "<string>",
  "replaceAll": false
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "oldString": "<string>",
    "newString": "<string>",
    "replaceAll": false
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v2/stable/agent/prompt?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "oldString": "<string>",
      "newString": "<string>",
      "replaceAll": False
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent patch-prompt --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "oldString": "<string>",
  "newString": "<string>",
  "replaceAll": false
}
JSON
```


## Search the global prompt

Searches the global prompt line by line with a JavaScript regular expression and returns one page of matching lines with surrounding context, up to `limit`; the match totals count the whole prompt.

### Endpoint

```http
POST /v2/stable/agent/prompt/search
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableInstructionsSearchRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns the matching lines of the global prompt, each with its line number, hit count and context lines, plus the total matches and matching lines across the whole prompt and whether the limit cut the list short.

Schema:

```json
{
  "$ref": "#/components/schemas/StableInstructionsSearchResponse"
}
```

Example:

```json
{
  "matches": [
    {
      "line": 0,
      "count": 0,
      "before": [
        "<string>"
      ],
      "text": "<string>",
      "after": [
        "<string>"
      ]
    }
  ],
  "totalMatches": 0,
  "matchingLines": 0,
  "hasMore": true
}
```

### Request examples

#### cURL

```bash
curl --request POST \
  --url 'https://realtime-api.voiceflow.com/v2/stable/agent/prompt/search?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pattern": "<string>",
  "ignoreCase": false,
  "contextLines": 0,
  "limit": 50
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/agent/prompt/search?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "pattern": "<string>",
    "ignoreCase": false,
    "contextLines": 0,
    "limit": 50
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v2/stable/agent/prompt/search?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "pattern": "<string>",
      "ignoreCase": False,
      "contextLines": 0,
      "limit": 50
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent search-prompt --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "pattern": "<string>",
  "ignoreCase": false,
  "contextLines": 0,
  "limit": 50
}
JSON
```


## Add agent tool message

Gives one of the agent's tools a message in a slot that has none yet, either generative (examples the model writes from) or scripted (an existing response said verbatim). Address a built-in tool with `nativeTool` or an attached tool with `toolID`, and compile the environment afterward.

### Endpoint

```http
POST /v1/stable/agent/tool-message
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `slot`

Required · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "$ref": "#/components/schemas/StableToolMessageSlot"
}
```

#### `toolID`

Optional · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "description": "A tool attached to this agent or playbook. Cannot be used with nativeTool.",
  "type": "string",
  "minLength": 1
}
```

#### `nativeTool`

Optional · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/StableNativeToolKey"
    }
  ]
}
```

### Request body

A tool message in one of its two forms. Writing one form switches the slot to it and leaves the other form stored but inactive, exactly as the editor does — so switching back does not have to be retyped.

Required

```json
{
  "required": true,
  "description": "A tool message in one of its two forms. Writing one form switches the slot to it and leaves the other form stored but inactive, exactly as the editor does — so switching back does not have to be retyped.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableToolMessageRequest"
      }
    }
  }
}
```

### Responses

#### 200

Confirms the message was set and which form, generative or scripted, the slot is now in.

Schema:

```json
{
  "$ref": "#/components/schemas/StableTextUpdateResponse"
}
```

Example:

```json
{
  "message": "<string>",
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request POST \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "generative",
  "examples": [
    "<string>"
  ]
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "generative",
    "examples": [
      "<string>"
    ]
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "type": "generative",
      "examples": [
        "<string>"
      ]
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent add-tool-message --project-id <projectID> --environment-alias <environmentAlias> --slot <slot> --tool-id <toolID> --native-tool <nativeTool> <<'JSON'
{
  "type": "generative",
  "examples": [
    "<string>"
  ]
}
JSON
```


## Update agent tool message

Replaces the message in a slot that already has one, with the full set of examples or the response to say instead. Switching between generative and scripted keeps the stored text of the form you switched away from, switched off.

### Endpoint

```http
PATCH /v1/stable/agent/tool-message
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `slot`

Required · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "$ref": "#/components/schemas/StableToolMessageSlot"
}
```

#### `toolID`

Optional · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "description": "A tool attached to this agent or playbook. Cannot be used with nativeTool.",
  "type": "string",
  "minLength": 1
}
```

#### `nativeTool`

Optional · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/StableNativeToolKey"
    }
  ]
}
```

### Request body

A tool message in one of its two forms. Writing one form switches the slot to it and leaves the other form stored but inactive, exactly as the editor does — so switching back does not have to be retyped.

Required

```json
{
  "required": true,
  "description": "A tool message in one of its two forms. Writing one form switches the slot to it and leaves the other form stored but inactive, exactly as the editor does — so switching back does not have to be retyped.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableToolMessageRequest"
      }
    }
  }
}
```

### Responses

#### 200

Confirms the message was replaced and which form, generative or scripted, the slot is now in.

Schema:

```json
{
  "$ref": "#/components/schemas/StableTextUpdateResponse"
}
```

Example:

```json
{
  "message": "<string>",
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "generative",
  "examples": [
    "<string>"
  ]
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "generative",
    "examples": [
      "<string>"
    ]
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "type": "generative",
      "examples": [
        "<string>"
      ]
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent update-tool-message --project-id <projectID> --environment-alias <environmentAlias> --slot <slot> --tool-id <toolID> --native-tool <nativeTool> <<'JSON'
{
  "type": "generative",
  "examples": [
    "<string>"
  ]
}
JSON
```


## Delete agent tool message

Clears one message slot on one of the agent's tools, discarding its examples and unlinking its scripted response. The response carries only a confirmation message, so refetch the agent's tool to see its remaining messages.

### Endpoint

```http
DELETE /v1/stable/agent/tool-message
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `slot`

Required · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "$ref": "#/components/schemas/StableToolMessageSlot"
}
```

#### `toolID`

Optional · string

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "description": "A tool attached to this agent or playbook. Cannot be used with nativeTool.",
  "type": "string",
  "minLength": 1
}
```

#### `nativeTool`

Optional · object

Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.

```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/StableNativeToolKey"
    }
  ]
}
```

### Responses

#### 200

Confirms the message in the requested slot was removed.

Schema:

```json
{
  "$ref": "#/components/schemas/StableDeleteResponse"
}
```

Example:

```json
{
  "message": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request DELETE \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent delete-tool-message --project-id <projectID> --environment-alias <environmentAlias> --slot <slot> --tool-id <toolID> --native-tool <nativeTool>
```


## Patch pronunciation dictionary

Edits single entries of the voice pronunciation dictionary, a list of written words and how the voice says them. `set` adds words or replaces the entry for a word already stored, `remove` deletes every entry for a word, and words match ignoring letter case.

### Endpoint

```http
PATCH /v1/stable/agent/pronunciation
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StableAgentPronunciationPatchRequest"
          }
        ]
      }
    }
  }
}
```

### Responses

#### 200

Returns how many entries were added, changed and removed, the words in `remove` the dictionary did not have, and how many entries the dictionary holds now.

Schema:

```json
{
  "$ref": "#/components/schemas/StableAgentPronunciationPatchResponse"
}
```

Example:

```json
{
  "message": "<string>",
  "added": 0,
  "replaced": 0,
  "removed": 0,
  "notFound": [
    "<string>"
  ],
  "totalEntries": 0
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/pronunciation?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "set": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "remove": [
    "<string>"
  ]
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/pronunciation?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "set": [
      {
        "from": "<string>",
        "to": "<string>"
      }
    ],
    "remove": [
      "<string>"
    ]
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1/stable/agent/pronunciation?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "set": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "remove": [
        "<string>"
      ]
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent patch-pronunciation --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "set": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "remove": [
    "<string>"
  ]
}
JSON
```


## Search voices

Search the ElevenLabs and Cartesia voice catalog.

### Endpoint

```http
GET /v1/stable/agent/voice-catalog
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `search`

Optional · string

Words to find in the name, description or accent, or one whole voice ID. Every word must match, ignoring case: "vikram" or "calm british".

```json
{
  "description": "Words to find in the name, description or accent, or one whole voice ID. Every word must match, ignoring case: \"vikram\" or \"calm british\".",
  "type": "string",
  "minLength": 1,
  "maxLength": 200
}
```

#### `language`

Optional · string

Only voices that speak this language: a language ("hi") or a language and region ("en-IN"). Native speakers come first, and with a region those native to it before the rest.

```json
{
  "description": "Only voices that speak this language: a language (\"hi\") or a language and region (\"en-IN\"). Native speakers come first, and with a region those native to it before the rest.",
  "type": "string",
  "minLength": 2,
  "maxLength": 35
}
```

#### `provider`

Optional · object



```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/StableCatalogVoiceProvider"
    }
  ]
}
```

#### `gender`

Optional · object



```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/StableCatalogVoiceGender"
    }
  ]
}
```

#### `limit`

Optional · integer

The most voices to return in one page.

```json
{
  "default": 10,
  "description": "The most voices to return in one page.",
  "type": "integer",
  "minimum": 1,
  "maximum": 25
}
```

#### `offset`

Optional · integer

How many matching voices to skip: nextOffset from the previous page.

```json
{
  "default": 0,
  "description": "How many matching voices to skip: nextOffset from the previous page.",
  "type": "integer",
  "minimum": 0,
  "maximum": 9007199254740991
}
```

### Responses

#### 200

Schema:

```json
{
  "$ref": "#/components/schemas/StableVoiceCatalogSearchResponse"
}
```

Example:

```json
{
  "voices": [
    {
      "provider": "elevenlabs",
      "voiceID": "<string>",
      "name": "<string>",
      "gender": "<StableCatalogVoiceGender>",
      "accent": "<string>",
      "description": "<string>",
      "nativeLanguages": [
        "<string>"
      ],
      "otherLanguages": [
        "<string>"
      ],
      "featured": true,
      "previewURL": "<string>"
    }
  ],
  "total": 0,
  "nextOffset": 0
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/voice-catalog?projectID=<projectID>&search=<search>&language=<language>&provider=<provider>&gender=<gender>&limit=<limit>&offset=<offset>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/voice-catalog?projectID=<projectID>&search=<search>&language=<language>&provider=<provider>&gender=<gender>&limit=<limit>&offset=<offset>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/agent/voice-catalog?projectID=<projectID>&search=<search>&language=<language>&provider=<provider>&gender=<gender>&limit=<limit>&offset=<offset>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent search-voices --project-id <projectID> --search <search> --language <language> --provider <provider> --gender <gender> --limit <limit> --offset <offset>
```


## Patch voices

Set the agent's default voice, or add, change or remove one language voice, from the voice catalog.

### Endpoint

```http
PATCH /v1/stable/agent/voices
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StableAgentVoicesPatchRequest"
          }
        ]
      }
    }
  }
}
```

### Responses

#### 200

Schema:

```json
{
  "$ref": "#/components/schemas/StableAgentVoicesPatchResponse"
}
```

Example:

```json
{
  "message": "<string>",
  "added": [
    "<string>"
  ],
  "replaced": [
    "<string>"
  ],
  "removed": [
    "<string>"
  ],
  "notFound": [
    "<string>"
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/voices?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "primary": {
    "provider": "<StableCatalogVoiceProvider>",
    "voiceID": "<string>",
    "model": "<string>"
  },
  "setOverrides": [
    {
      "locale": "<string>",
      "provider": "<StableCatalogVoiceProvider>",
      "voiceID": "<string>",
      "model": "<string>"
    }
  ],
  "removeOverrides": [
    "<string>"
  ]
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/voices?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "primary": {
      "provider": "<StableCatalogVoiceProvider>",
      "voiceID": "<string>",
      "model": "<string>"
    },
    "setOverrides": [
      {
        "locale": "<string>",
        "provider": "<StableCatalogVoiceProvider>",
        "voiceID": "<string>",
        "model": "<string>"
      }
    ],
    "removeOverrides": [
      "<string>"
    ]
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1/stable/agent/voices?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "primary": {
        "provider": "<StableCatalogVoiceProvider>",
        "voiceID": "<string>",
        "model": "<string>"
      },
      "setOverrides": [
        {
          "locale": "<string>",
          "provider": "<StableCatalogVoiceProvider>",
          "voiceID": "<string>",
          "model": "<string>"
        }
      ],
      "removeOverrides": [
        "<string>"
      ]
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent patch-voices --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "primary": {
    "provider": "<StableCatalogVoiceProvider>",
    "voiceID": "<string>",
    "model": "<string>"
  },
  "setOverrides": [
    {
      "locale": "<string>",
      "provider": "<StableCatalogVoiceProvider>",
      "voiceID": "<string>",
      "model": "<string>"
    }
  ],
  "removeOverrides": [
    "<string>"
  ]
}
JSON
```


## Get initialization workflow

Returns the agent's initialization workflow, the workflow set in Behaviour settings that runs at launch, before the user says anything. The name is null when the ID points at a workflow that no longer exists.

### Endpoint

```http
GET /v1/stable/agent/initialization-workflow
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Responses

#### 200

Returns the ID and name of the initialization workflow, both null when none is set or when the project has no initialization workflow setting.

Schema:

```json
{
  "$ref": "#/components/schemas/StableAgentInitializationWorkflowResponse"
}
```

Example:

```json
{
  "workflowID": "<string>",
  "name": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent get-initialization-workflow --project-id <projectID> --environment-alias <environmentAlias>
```


## Set initialization workflow

Sets which workflow the agent runs at launch, replacing the one set before, or clears the setting when `workflowID` is null. Only a workflow ID from the workflow list is accepted, and compiling the environment is what makes a test conversation use it.

### Endpoint

```http
PUT /v1/stable/agent/initialization-workflow
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableAgentInitializationWorkflowRequest"
      }
    }
  }
}
```

### Responses

#### 200

Confirms which workflow now runs before the user's first turn, or that none does, and names the workflow it replaced when there was one.

Schema:

```json
{
  "$ref": "#/components/schemas/StableUpdateResponse"
}
```

Example:

```json
{
  "message": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request PUT \
  --url 'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workflowID": "<string>"
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "workflowID": "<string>"
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.put(
    'https://realtime-api.voiceflow.com/v1/stable/agent/initialization-workflow?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "workflowID": "<string>"
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf agent set-initialization-workflow --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "workflowID": "<string>"
}
JSON
```


## Schema definitions

### AIModel

```json
{
  "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"
  ]
}
```

### AIParamsServiceTier

```json
{
  "type": "string",
  "enum": [
    "default",
    "flex",
    "priority"
  ],
  "x-enumNames": [
    "DEFAULT",
    "FLEX",
    "PRIORITY"
  ]
}
```

### AIReasoningEffort

```json
{
  "type": "string",
  "enum": [
    "off",
    "adaptive",
    "minimal",
    "low",
    "medium",
    "high"
  ],
  "x-enumNames": [
    "OFF",
    "ADAPTIVE",
    "MINIMAL",
    "LOW",
    "MEDIUM",
    "HIGH"
  ]
}
```

### AgentKnowledgeBaseToolQueryMode

```json
{
  "type": "string",
  "enum": [
    "custom",
    "rewriting"
  ],
  "x-enumNames": [
    "CUSTOM",
    "REWRITING"
  ]
}
```

### AgentSkipTurnTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "description"
  ]
}
```

### AmazonVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "amazon"
      ],
      "x-enumNames": [
        "AMAZON"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

### AssemblyAISTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "min_latency",
    "balanced",
    "max_accuracy"
  ],
  "x-enumNames": [
    "MIN_LATENCY",
    "BALANCED",
    "MAX_ACCURACY"
  ]
}
```

### AssemblyAISTTModel

```json
{
  "type": "string",
  "enum": [
    "universal-streaming-english",
    "universal-3-5-pro"
  ],
  "x-enumNames": [
    "UNIVERSAL_STREAMING_ENGLISH",
    "UNIVERSAL_3_5_PRO"
  ]
}
```

### AssemblyAISTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "assemblyai"
      ],
      "x-enumNames": [
        "ASSEMBLYAI"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTModel"
        }
      ]
    },
    "mode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTMode"
        }
      ]
    },
    "language": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTLanguage"
        }
      ]
    },
    "keyterms": {
      "type": "string"
    },
    "confidenceThreshold": {
      "default": 0.7,
      "type": "number"
    },
    "maxTurnSilence": {
      "default": 2400,
      "type": "number"
    },
    "minTurnSilence": {
      "default": 160,
      "type": "number"
    }
  },
  "required": [
    "provider"
  ]
}
```

### BackgroundAudioSettings

```json
{
  "type": "object",
  "properties": {
    "volume": {
      "default": 0.75,
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  }
}
```

### CallForwardAddressType

```json
{
  "type": "string",
  "enum": [
    "phone",
    "sip"
  ],
  "x-enumNames": [
    "PHONE",
    "SIP"
  ]
}
```

### CartesiaSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "ink-whisper",
    "ink-2"
  ],
  "x-enumNames": [
    "INK_WHISPER",
    "INK_2"
  ]
}
```

### CartesiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/CartesiaSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/CartesiaSTTLanguage"
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

### CartesiaVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "speed": {
          "type": "number",
          "minimum": 0.6,
          "maximum": 1.5
        }
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice"
  ]
}
```

### ConditionAssertionLhs

```json
{
  "type": "object",
  "properties": {
    "variableID": {
      "nullable": true,
      "type": "string"
    },
    "path": {
      "type": "string"
    }
  },
  "required": [
    "variableID"
  ]
}
```

### ConditionOperation

```json
{
  "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"
  ]
}
```

### CrewNodeDataRequiredVariable

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "description": {
      "nullable": true,
      "type": "string"
    },
    "variableOrEntityID": {
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "id",
    "description",
    "variableOrEntityID"
  ]
}
```

### DTMFDelimiter

```json
{
  "type": "string",
  "enum": [
    "#",
    "*"
  ],
  "x-enumNames": [
    "#",
    "*"
  ]
}
```

### DeepgramSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "nova-2",
    "nova-3",
    "nova-3-medical",
    "flux"
  ],
  "x-enumNames": [
    "NOVA_2",
    "NOVA_3",
    "NOVA_3_MEDICAL",
    "FLUX"
  ]
}
```

### DeepgramSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "deepgram"
      ],
      "x-enumNames": [
        "DEEPGRAM"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeepgramSTTModel"
        }
      ]
    },
    "locale": {
      "allOf": [
        {
          "$ref": "#/components/schemas/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": "#/components/schemas/DeepgramSTTLanguage"
      }
    }
  },
  "required": [
    "provider"
  ]
}
```

### DefaultValueString

```json
{
  "type": "string",
  "description": "Plain text resolved at runtime and never shown to a model. {variable_name} inserts a variable or entity, {secret_name} a project secret, {variable_name.path} a field of a variable. Escape a literal { or \\ with a backslash. When a name is both a variable and a secret, the secret wins. A name matching none is stored as literal text and reported in unresolvedReferences. Where the field is sent to an upstream system, an unresolved placeholder may be sent as literal text; on an MCP server it is re-resolved by name at connect time, so a literal that matches a real secret binds."
}
```

### ElevenLabsSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "scribe_v2_realtime"
  ],
  "x-enumNames": [
    "SCRIBE_V_2_REALTIME"
  ]
}
```

### ElevenLabsSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/ElevenLabsSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/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
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

### ElevenLabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "useCustomVoice": {
      "type": "boolean"
    },
    "settings": {
      "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"
        ]
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice",
    "settings"
  ]
}
```

### GladiaSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "solaria-1"
  ],
  "x-enumNames": [
    "SOLARIA_1"
  ]
}
```

### GladiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "gladia"
      ],
      "x-enumNames": [
        "GLADIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GladiaSTTModel"
    },
    "endpointing": {
      "type": "number"
    },
    "maxDurationWithoutEndpointing": {
      "type": "number"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GladiaSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "endpointing",
    "maxDurationWithoutEndpointing",
    "languages"
  ]
}
```

### GoogleSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "chirp_3"
  ],
  "x-enumNames": [
    "CHIRP_3"
  ]
}
```

### GoogleSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GoogleSTTModel"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoogleSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

### GoogleTTSModelID

```json
{
  "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

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GoogleTTSModelID"
        }
      ]
    },
    "languageCode": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "prompt": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

### MarkdownLikeString

```json
{
  "type": "string",
  "description": "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."
}
```

### MarkdownText

```json
{
  "type": "string",
  "description": "Markdown text. Backticked `Name` resolves to a tool, playbook, or workflow reference, and a system tool is written as its field name, such as `webSearchTool`; braced {name} resolves to a variable or entity reference. A name that resolves to nothing is stored as literal text and reported back in the response. Text is saved in one form: a numbered list keeps its first number and counts up from it, bullets are -, italics are _x_, a nested list is indented to its parent's text, and every callout line starts with >. Outside inline code a backslash before punctuation is a markdown escape and is not kept; put regular expressions and code in backticks."
}
```

### MicrosoftVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "microsoft"
      ],
      "x-enumNames": [
        "MICROSOFT"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

### PronunciationDictionaryEntry

```json
{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "to": {
      "type": "string",
      "maxLength": 128
    }
  },
  "required": [
    "from",
    "to"
  ]
}
```

### RimelabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "rimelabs"
      ],
      "x-enumNames": [
        "RIMELABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

### STTSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ElevenLabsSTTSettings"
    },
    {
      "$ref": "#/components/schemas/DeepgramSTTSettings"
    },
    {
      "$ref": "#/components/schemas/AssemblyAISTTSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GladiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleSTTSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxSTTSettings"
    }
  ]
}
```

### SonioxSTTLanguage

```json
{
  "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

```json
{
  "type": "string",
  "enum": [
    "stt-rt-v5"
  ],
  "x-enumNames": [
    "STT_RT_V_5"
  ]
}
```

### SonioxSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/SonioxSTTModel"
    },
    "maxEndpointDelayMS": {
      "type": "integer",
      "minimum": 500,
      "maximum": 3000
    },
    "endpointSensitivity": {
      "type": "number",
      "minimum": -1,
      "maximum": 1
    },
    "keyterms": {
      "type": "string"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SonioxSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

### SonioxVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

### StableAgentInitializationWorkflowRequest

```json
{
  "type": "object",
  "properties": {
    "workflowID": {
      "nullable": true,
      "description": "The workflow to run before the user's first turn, or null to run none.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "workflowID"
  ],
  "additionalProperties": false
}
```

### StableAgentInitializationWorkflowResponse

```json
{
  "type": "object",
  "properties": {
    "workflowID": {
      "nullable": true,
      "description": "The workflow that runs before the user's first turn, or null when none is set or this project has no initialization workflow setting.",
      "type": "string"
    },
    "name": {
      "nullable": true,
      "description": "That workflow's name. Null when none is set, or when the stored ID names a workflow that no longer exists.",
      "type": "string"
    }
  },
  "required": [
    "workflowID",
    "name"
  ]
}
```

### StableAgentPronunciationPatchRequest

```json
{
  "type": "object",
  "properties": {
    "set": {
      "description": "Words to add, or to change when the dictionary already has them. `from` is the written word and `to` is how the voice says it; an empty `to` makes the voice skip the word.",
      "minItems": 1,
      "maxItems": 500,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PronunciationDictionaryEntry"
      }
    },
    "remove": {
      "description": "Written words whose entries to delete.",
      "minItems": 1,
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    }
  },
  "additionalProperties": false
}
```

### StableAgentPronunciationPatchResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    },
    "added": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many new words the dictionary gained."
    },
    "replaced": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many stored words got the pronunciation this call sent."
    },
    "removed": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many entries were deleted."
    },
    "notFound": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Words in `remove` the dictionary did not have. Nothing was deleted for them."
    },
    "totalEntries": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many entries the dictionary holds now."
    }
  },
  "required": [
    "message",
    "added",
    "replaced",
    "removed",
    "notFound",
    "totalEntries"
  ]
}
```

### StableAgentReadV2

```json
{
  "type": "object",
  "properties": {
    "llm": {
      "type": "object",
      "properties": {
        "priorityProcessing": {
          "description": "@deprecated Faster processing is set per model: use `serviceTier: 'priority'` in each model's settings. This project-level flag still applies to any model setting that leaves `serviceTier` unset.",
          "type": "boolean"
        },
        "defaults": {
          "type": "object",
          "properties": {
            "model": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/AIModel"
                }
              ]
            },
            "maxTokens": {
              "type": "number"
            },
            "temperature": {
              "type": "number"
            },
            "reasoningEffort": {
              "nullable": true,
              "allOf": [
                {
                  "$ref": "#/components/schemas/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": "#/components/schemas/AIParamsServiceTier"
                }
              ]
            }
          }
        }
      }
    },
    "prompt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MarkdownText"
        }
      ]
    },
    "includeGuidelines": {
      "type": "boolean",
      "description": "Whether to append the default prompting guidelines to the global prompt."
    },
    "voice": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionSettingsVoice"
        }
      ]
    },
    "playbooks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "condition": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/StableExpressionCondition"
              }
            ]
          },
          "description": {
            "nullable": true,
            "type": "string"
          },
          "requiredVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CrewNodeDataRequiredVariable"
            }
          },
          "playbookID": {
            "type": "string"
          }
        },
        "required": [
          "description",
          "playbookID"
        ]
      },
      "description": "Playbooks available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no playbooks AND no workflows registered cannot run - the runtime fails the conversation - so never send an empty list unless `workflows` still holds at least one."
    },
    "workflows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "condition": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/StableExpressionCondition"
              }
            ]
          },
          "description": {
            "nullable": true,
            "type": "string"
          },
          "requiredVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CrewNodeDataRequiredVariable"
            }
          },
          "workflowID": {
            "type": "string"
          }
        },
        "required": [
          "description",
          "workflowID"
        ]
      },
      "description": "Workflows available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no workflows AND no playbooks registered cannot run, so never send an empty list unless `playbooks` still holds at least one."
    },
    "endTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableEndTool"
        }
      ]
    },
    "cardTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCardTool"
        }
      ]
    },
    "buttonTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableButtonTool"
        }
      ]
    },
    "carouselTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCardTool"
        }
      ]
    },
    "webSearchTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableWebSearchTool"
        }
      ]
    },
    "callForwardTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCallForwardTool"
        }
      ]
    },
    "knowledgeBaseTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableKnowledgeBaseTool"
        }
      ]
    },
    "instructions": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/MarkdownText"
        }
      ]
    },
    "skipTurnTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AgentSkipTurnTool"
        }
      ]
    },
    "pathToolOrder": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The ordered list of path tool IDs that controls the order of the agent exit paths."
    },
    "promptLineCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many lines the global prompt has."
    },
    "instructionsLineCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many lines the main agent's instructions have."
    }
  },
  "required": [
    "llm",
    "includeGuidelines",
    "playbooks",
    "workflows",
    "endTool",
    "cardTool",
    "buttonTool",
    "carouselTool",
    "webSearchTool",
    "callForwardTool",
    "knowledgeBaseTool",
    "skipTurnTool",
    "pathToolOrder",
    "promptLineCount",
    "instructionsLineCount"
  ]
}
```

### StableAgentResponseV2

```json
{
  "type": "object",
  "properties": {
    "agent": {
      "$ref": "#/components/schemas/StableAgentReadV2"
    }
  },
  "required": [
    "agent"
  ]
}
```

### StableAgentUpdateRequestV2

```json
{
  "type": "object",
  "properties": {
    "prompt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MarkdownText"
        }
      ]
    },
    "endTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableEndTool"
        }
      ]
    },
    "cardTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCardTool"
        }
      ]
    },
    "playbooks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "condition": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/StableExpressionCondition"
              }
            ]
          },
          "description": {
            "nullable": true,
            "type": "string"
          },
          "requiredVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StableRoutingRequiredVariableInput"
            }
          },
          "playbookID": {
            "type": "string"
          }
        },
        "required": [
          "description",
          "playbookID"
        ]
      },
      "description": "Playbooks available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no playbooks AND no workflows registered cannot run - the runtime fails the conversation - so never send an empty list unless `workflows` still holds at least one."
    },
    "workflows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "condition": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/StableExpressionCondition"
              }
            ]
          },
          "description": {
            "nullable": true,
            "type": "string"
          },
          "requiredVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StableRoutingRequiredVariableInput"
            }
          },
          "workflowID": {
            "type": "string"
          }
        },
        "required": [
          "description",
          "workflowID"
        ]
      },
      "description": "Workflows available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no workflows AND no playbooks registered cannot run, so never send an empty list unless `playbooks` still holds at least one."
    },
    "buttonTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableButtonTool"
        }
      ]
    },
    "carouselTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCardTool"
        }
      ]
    },
    "instructions": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/MarkdownText"
        }
      ]
    },
    "skipTurnTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AgentSkipTurnTool"
        }
      ]
    },
    "pathToolOrder": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The ordered list of path tool IDs that controls the order of the agent exit paths."
    },
    "webSearchTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableWebSearchTool"
        }
      ]
    },
    "callForwardTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCallForwardTool"
        }
      ]
    },
    "knowledgeBaseTool": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableKnowledgeBaseTool"
        }
      ]
    },
    "includeGuidelines": {
      "type": "boolean",
      "description": "Whether to append the default prompting guidelines to the global prompt."
    },
    "llm": {
      "type": "object",
      "properties": {
        "priorityProcessing": {
          "description": "@deprecated Faster processing is set per model: use `serviceTier: 'priority'` in each model's settings. This project-level flag still applies to any model setting that leaves `serviceTier` unset.",
          "type": "boolean"
        },
        "defaults": {
          "type": "object",
          "properties": {
            "model": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/AIModel"
                }
              ]
            },
            "maxTokens": {
              "type": "number"
            },
            "temperature": {
              "type": "number"
            },
            "reasoningEffort": {
              "nullable": true,
              "allOf": [
                {
                  "$ref": "#/components/schemas/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": "#/components/schemas/AIParamsServiceTier"
                }
              ]
            }
          }
        }
      }
    },
    "voice": {
      "type": "object",
      "properties": {
        "stt": {
          "allOf": [
            {
              "$ref": "#/components/schemas/STTSettings"
            }
          ]
        },
        "tts": {
          "allOf": [
            {
              "$ref": "#/components/schemas/VoiceSettings"
            }
          ]
        },
        "localeOverrides": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/VoiceLocaleOverride"
          }
        },
        "pronunciationDictionary": {
          "maxItems": 500,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/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": "#/components/schemas/BackgroundAudioSettings"
            }
          ]
        },
        "audioSync": {
          "type": "boolean"
        },
        "keypadInput": {
          "allOf": [
            {
              "$ref": "#/components/schemas/VoiceKeypadSettings"
            }
          ]
        },
        "silenceTimeoutMs": {
          "type": "number"
        },
        "maxDuration": {
          "allOf": [
            {
              "$ref": "#/components/schemas/VoiceMaxDurationSettings"
            }
          ]
        },
        "callerIdentity": {
          "allOf": [
            {
              "$ref": "#/components/schemas/VersionSettingsVoiceCallerIdentity"
            }
          ]
        }
      }
    }
  },
  "additionalProperties": false
}
```

### StableAgentVoicesPatchRequest

```json
{
  "type": "object",
  "properties": {
    "primary": {
      "description": "The default voice: the one a conversation speaks with unless a language voice matches its locale.",
      "allOf": [
        {
          "$ref": "#/components/schemas/StableVoicePick"
        }
      ]
    },
    "setOverrides": {
      "description": "Language voices to add, or to change when the agent already has one for that locale.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableVoiceOverridePick"
      }
    },
    "removeOverrides": {
      "description": "Locales whose language voice to delete, as stored. They match ignoring case and _, as the runtime matches them.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    }
  },
  "additionalProperties": false
}
```

### StableAgentVoicesPatchResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    },
    "added": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locales that got a language voice they did not have."
    },
    "replaced": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locales whose language voice changed."
    },
    "removed": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locales whose language voice was deleted."
    },
    "notFound": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locales in removeOverrides the agent had no language voice for. Nothing was deleted for them."
    }
  },
  "required": [
    "message",
    "added",
    "replaced",
    "removed",
    "notFound"
  ]
}
```

### StableButtonTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "description"
  ]
}
```

### StableCallForwardTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "address": {
      "$ref": "#/components/schemas/VariableReferenceString"
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "extension": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VariableReferenceString"
        }
      ]
    },
    "toolSound": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/ToolNodeDataToolSound"
        }
      ]
    },
    "description": {
      "type": "string"
    },
    "addressType": {
      "$ref": "#/components/schemas/CallForwardAddressType"
    },
    "callerIDPassthrough": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled",
    "address",
    "description",
    "addressType"
  ]
}
```

### StableCardTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "description"
  ]
}
```

### StableCatalogVoice

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "$ref": "#/components/schemas/StableCatalogVoiceProvider"
    },
    "voiceID": {
      "type": "string",
      "description": "The ID to pick the voice with."
    },
    "name": {
      "type": "string"
    },
    "gender": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableCatalogVoiceGender"
        }
      ]
    },
    "accent": {
      "nullable": true,
      "type": "string"
    },
    "description": {
      "nullable": true,
      "description": "The vendor's description, cut to 200 characters.",
      "type": "string"
    },
    "nativeLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The languages the voice is native in: a language and region where the catalog gives one (\"en-IN\"), else a language (\"hi\")."
    },
    "otherLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Other languages the voice can speak, as language codes."
    },
    "featured": {
      "type": "boolean",
      "description": "The vendor recommends the voice for one of its languages."
    },
    "previewURL": {
      "nullable": true,
      "description": "A link to an audio sample, for the user to hear the voice: in the language asked for when the catalog has one, else in the voice's own language.",
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voiceID",
    "name",
    "gender",
    "accent",
    "description",
    "nativeLanguages",
    "otherLanguages",
    "featured",
    "previewURL"
  ]
}
```

### StableCatalogVoiceGender

```json
{
  "type": "string",
  "enum": [
    "male",
    "female",
    "neutral"
  ],
  "description": "How the vendor describes the voice.",
  "x-enumNames": [
    "MALE",
    "FEMALE",
    "NEUTRAL"
  ]
}
```

### StableCatalogVoiceProvider

```json
{
  "type": "string",
  "enum": [
    "elevenlabs",
    "cartesia"
  ],
  "description": "A TTS provider whose voices are in the voice catalog.",
  "x-enumNames": [
    "ELEVENLABS",
    "CARTESIA"
  ]
}
```

### StableConditionAssertion

```json
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "lhs": {
      "$ref": "#/components/schemas/ConditionAssertionLhs"
    },
    "rhs": {
      "$ref": "#/components/schemas/VariableReferenceString"
    },
    "operation": {
      "default": "is",
      "allOf": [
        {
          "$ref": "#/components/schemas/ConditionOperation"
        }
      ]
    }
  },
  "required": [
    "key",
    "lhs",
    "rhs"
  ]
}
```

### StableDeleteResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the deletion."
    }
  },
  "required": [
    "message"
  ]
}
```

### StableEndTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "toolSound": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/ToolNodeDataToolSound"
        }
      ]
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "description"
  ]
}
```

### StableExpressionCondition

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "value-variable"
      ],
      "x-enumNames": [
        "VALUE_VARIABLE"
      ]
    },
    "matchAll": {
      "type": "boolean"
    },
    "assertions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableConditionAssertion"
      }
    }
  },
  "required": [
    "type",
    "matchAll",
    "assertions"
  ]
}
```

### StableInstructionsPatchRequest

```json
{
  "type": "object",
  "properties": {
    "oldString": {
      "type": "string",
      "minLength": 1,
      "description": "The exact text to replace, copied verbatim from a read or search result. Matching is literal — whitespace, punctuation and case must match. Do not include the line numbers a read adds."
    },
    "newString": {
      "type": "string",
      "description": "The text to put in its place. May be empty to delete."
    },
    "replaceAll": {
      "default": false,
      "description": "Replace every occurrence. When false, more than one match is an error rather than a guess.",
      "type": "boolean"
    }
  },
  "required": [
    "oldString",
    "newString"
  ],
  "additionalProperties": false
}
```

### StableInstructionsPatchResponseV2

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable summary naming the lines that changed."
    },
    "replacements": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many occurrences were replaced."
    },
    "diff": {
      "type": "string",
      "description": "A unified diff of the changed lines, with 1-based hunk headers."
    },
    "totalLines": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many lines the document has AFTER the write."
    },
    "unresolvedReferences": {
      "description": "References this write kept as literal text instead of binding, each with the reason. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedReference"
      }
    },
    "unresolvedMentions": {
      "description": "Backticked `name` mentions that matched no attached tool, playbook or workflow and were stored as inline code. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedMention"
      }
    }
  },
  "required": [
    "message",
    "replacements",
    "diff",
    "totalLines"
  ]
}
```

### StableInstructionsReadResponseV2

```json
{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "description": "The requested lines, each as its 1-based number, a tab, then the text, joined by newlines."
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "The line number this page actually starts at, after clamping."
    },
    "returnedLines": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many lines this page carries."
    },
    "totalLines": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many lines the whole document has."
    },
    "totalCharacters": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many characters the whole document has."
    },
    "hasMore": {
      "type": "boolean",
      "description": "Whether lines remain after this page."
    },
    "nextOffset": {
      "nullable": true,
      "description": "The first line not returned, or null when there is nothing more to read.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "note": {
      "description": "Names the backticked names on this page that are links to a tool, playbook or workflow. A link reads as the resource's current name, whatever spelling the write used. Absent when the page shows no link.",
      "type": "string"
    }
  },
  "required": [
    "content",
    "offset",
    "returnedLines",
    "totalLines",
    "totalCharacters",
    "hasMore",
    "nextOffset"
  ]
}
```

### StableInstructionsSearchMatch

```json
{
  "type": "object",
  "properties": {
    "line": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "The 1-based line number of the match."
    },
    "count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many times the pattern matched on this line."
    },
    "before": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The requested lines of context above this one."
    },
    "text": {
      "type": "string",
      "description": "The matching line."
    },
    "after": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The requested lines of context below this one."
    }
  },
  "required": [
    "line",
    "count",
    "before",
    "text",
    "after"
  ]
}
```

### StableInstructionsSearchRequest

```json
{
  "type": "object",
  "properties": {
    "pattern": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "description": "A JavaScript regular expression, evaluated against each line on its own."
    },
    "ignoreCase": {
      "default": false,
      "description": "Match case-insensitively. Defaults to false, like grep.",
      "type": "boolean"
    },
    "contextLines": {
      "default": 0,
      "description": "How many lines either side of each match to return.",
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "limit": {
      "default": 50,
      "description": "The maximum number of matching LINES to return. The reported totals cover the whole document.",
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "required": [
    "pattern"
  ],
  "additionalProperties": false
}
```

### StableInstructionsSearchResponse

```json
{
  "type": "object",
  "properties": {
    "matches": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableInstructionsSearchMatch"
      }
    },
    "totalMatches": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Total occurrences across the whole document, not just this page."
    },
    "matchingLines": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Total lines with at least one occurrence, across the whole document."
    },
    "hasMore": {
      "type": "boolean",
      "description": "Whether matching lines were left out because of the limit."
    }
  },
  "required": [
    "matches",
    "totalMatches",
    "matchingLines",
    "hasMore"
  ]
}
```

### StableKBFilter

```json
{
  "type": "object",
  "properties": {
    "description": {
      "default": null,
      "nullable": true,
      "type": "string"
    },
    "defaultValue": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/DefaultValueString"
        }
      ]
    },
    "key": {
      "type": "string"
    }
  },
  "required": [
    "key"
  ]
}
```

### StableKnowledgeBaseTool

```json
{
  "type": "object",
  "properties": {
    "query": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/VariableReferenceString"
        }
      ]
    },
    "enabled": {
      "type": "boolean"
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableKBFilter"
      }
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "toolSound": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/ToolNodeDataToolSound"
        }
      ]
    },
    "chunkLimit": {
      "nullable": true,
      "type": "number"
    },
    "description": {
      "type": "string"
    },
    "queryMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AgentKnowledgeBaseToolQueryMode"
        }
      ]
    },
    "sourceUrlsCount": {
      "nullable": true,
      "type": "number",
      "minimum": 1,
      "maximum": 5
    }
  },
  "required": [
    "enabled",
    "description"
  ]
}
```

### StableMarkdownUpdateResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    },
    "unresolvedReferences": {
      "description": "References this write kept as literal text instead of binding, each with the reason. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedReference"
      }
    },
    "unresolvedMentions": {
      "description": "Backticked `name` mentions that matched no attached tool, playbook or workflow and were stored as inline code. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedMention"
      }
    }
  },
  "required": [
    "message"
  ]
}
```

### StableNativeToolKey

```json
{
  "type": "string",
  "enum": [
    "endTool",
    "cardTool",
    "buttonTool",
    "carouselTool",
    "webSearchTool",
    "callForwardTool",
    "knowledgeBaseTool"
  ],
  "description": "One of the built-in tools on this agent or playbook, under the same key it is read back at. skipTurnTool is absent because it carries no messages. The Voiceflow editor offers only the execution message on endTool, cardTool, buttonTool, carouselTool and callForwardTool; webSearchTool and knowledgeBaseTool offer all four. This API accepts any slot on any of them.",
  "x-enumNames": [
    "END_TOOL",
    "CARD_TOOL",
    "BUTTON_TOOL",
    "CAROUSEL_TOOL",
    "WEB_SEARCH_TOOL",
    "CALL_FORWARD_TOOL",
    "KNOWLEDGE_BASE_TOOL"
  ]
}
```

### StableRoutingRequiredVariableInput

```json
{
  "type": "object",
  "properties": {
    "id": {
      "description": "Keep it as read for a variable already on the entry. Leave it out for a new one: the system gives it.",
      "type": "string"
    },
    "description": {
      "nullable": true,
      "type": "string"
    },
    "variableOrEntityID": {
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "description",
    "variableOrEntityID"
  ]
}
```

### StableTextUpdateResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    },
    "unresolvedReferences": {
      "description": "References this write kept as literal text instead of binding, each with the reason. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedReference"
      }
    }
  },
  "required": [
    "message"
  ]
}
```

### StableToolMessageGenerative

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "examples": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MarkdownLikeString"
      }
    }
  },
  "required": [
    "enabled"
  ]
}
```

### StableToolMessageRequest

```json
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "generative"
          ],
          "description": "Discriminator: the model writes this message itself, guided by the examples below.",
          "x-enumNames": [
            "GENERATIVE"
          ]
        },
        "examples": {
          "minItems": 1,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MarkdownLikeString"
          },
          "description": "Example phrasings the model writes from. Replaces every example the slot holds today."
        }
      },
      "required": [
        "type",
        "examples"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "scripted"
          ],
          "description": "Discriminator: this message is a fixed response, said verbatim.",
          "x-enumNames": [
            "SCRIPTED"
          ]
        },
        "messageID": {
          "type": "string",
          "description": "The ID of an existing response in this environment — the same ID this slot reports as <slot>MessageID on a read."
        }
      },
      "required": [
        "type",
        "messageID"
      ],
      "additionalProperties": false
    }
  ],
  "description": "A tool message in one of its two forms. Writing one form switches the slot to it and leaves the other form stored but inactive, exactly as the editor does — so switching back does not have to be retyped."
}
```

### StableToolMessageSlot

```json
{
  "type": "string",
  "enum": [
    "delay",
    "failure",
    "execution",
    "completion"
  ],
  "description": "Which of the tool's four messages to write. `execution` is said when the tool starts (the editor labels it Start), `completion` when it finishes (Complete), `failure` when it errors (Failed), `delay` when it is taking a while (Delayed).",
  "x-enumNames": [
    "DELAY",
    "FAILURE",
    "EXECUTION",
    "COMPLETION"
  ]
}
```

### StableToolMessages

```json
{
  "type": "object",
  "properties": {
    "generative": {
      "type": "object",
      "properties": {
        "execution": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "failure": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "delay": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "completion": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        }
      }
    },
    "delayMessageID": {
      "nullable": true,
      "type": "string"
    },
    "failureMessageID": {
      "nullable": true,
      "type": "string"
    },
    "executionMessageID": {
      "nullable": true,
      "type": "string"
    },
    "completionMessageID": {
      "nullable": true,
      "type": "string"
    },
    "delayMessageSeconds": {
      "nullable": true,
      "type": "number"
    }
  },
  "required": [
    "delayMessageID",
    "failureMessageID",
    "executionMessageID",
    "completionMessageID",
    "delayMessageSeconds"
  ]
}
```

### StableUnresolvedMention

```json
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "Dotted path of the markdown field that carried it, e.g. `instructions` or `playbooks[3].instructions`."
    },
    "mention": {
      "type": "string",
      "description": "The mention as written, without backticks."
    }
  },
  "required": [
    "path",
    "mention"
  ]
}
```

### StableUnresolvedReference

```json
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "Dotted path of the field that carried it, e.g. `knowledgeBaseTool.filters[0].defaultValue`."
    },
    "token": {
      "type": "string",
      "description": "The reference as written, without braces."
    },
    "reason": {
      "type": "string",
      "enum": [
        "unknown",
        "secret-not-allowed",
        "path-on-non-variable",
        "resource-id",
        "invalid-name",
        "dangling"
      ],
      "description": "`unknown`: no variable or entity of that name. `secret-not-allowed`: the name is a project secret and this field does not accept one. `path-on-non-variable`: only a variable has fields. `resource-id`: a bare resource id, not a name. `invalid-name`: outside the `^\\w{1,64}$` name grammar. `dangling`: the reference rendered as a bare id, because its row is gone or its name is outside the name grammar.",
      "x-enumNames": [
        "UNKNOWN",
        "SECRET_NOT_ALLOWED",
        "PATH_ON_NON_VARIABLE",
        "RESOURCE_ID",
        "INVALID_NAME",
        "DANGLING"
      ]
    }
  },
  "required": [
    "path",
    "token",
    "reason"
  ]
}
```

### StableUpdateResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    }
  },
  "required": [
    "message"
  ]
}
```

### StableVoiceCatalogSearchResponse

```json
{
  "type": "object",
  "properties": {
    "voices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableCatalogVoice"
      },
      "description": "This page of the matching voices, best match first."
    },
    "total": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "How many voices match, across every page."
    },
    "nextOffset": {
      "nullable": true,
      "description": "The offset of the next page, or null when this page reaches the last match.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "voices",
    "total",
    "nextOffset"
  ]
}
```

### StableVoiceOverridePick

```json
{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "minLength": 2,
      "maxLength": 35,
      "description": "A language (\"fr\") or a language and region (\"fr-CA\"), as the conversation's `locale` variable holds it."
    },
    "provider": {
      "$ref": "#/components/schemas/StableCatalogVoiceProvider"
    },
    "voiceID": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "The voiceID a voice search returned. Never a guessed or made-up ID."
    },
    "model": {
      "description": "The TTS model. Leave it out to keep the current model, or to use the provider's default model when the provider changes.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "locale",
    "provider",
    "voiceID"
  ],
  "additionalProperties": false
}
```

### StableVoicePick

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "$ref": "#/components/schemas/StableCatalogVoiceProvider"
    },
    "voiceID": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "The voiceID a voice search returned. Never a guessed or made-up ID."
    },
    "model": {
      "description": "The TTS model. Leave it out to keep the current model, or to use the provider's default model when the provider changes.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "provider",
    "voiceID"
  ],
  "additionalProperties": false
}
```

### StableWebSearchTool

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "messages": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "toolSound": {
      "default": null,
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/ToolNodeDataToolSound"
        }
      ]
    },
    "description": {
      "type": "string"
    },
    "allowedDomains": {
      "nullable": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sourceUrlsCount": {
      "nullable": true,
      "type": "number",
      "minimum": 1,
      "maximum": 5
    }
  },
  "required": [
    "enabled"
  ]
}
```

### ToolNodeDataToolSound

```json
{
  "type": "object",
  "properties": {
    "ref": {
      "nullable": true,
      "type": "string"
    },
    "volume": {
      "default": 0.75,
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  },
  "required": [
    "ref"
  ]
}
```

### VariableReferenceString

```json
{
  "type": "string",
  "description": "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."
}
```

### VersionSettingsVoice

```json
{
  "type": "object",
  "properties": {
    "stt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/STTSettings"
        }
      ]
    },
    "tts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceSettings"
        }
      ]
    },
    "localeOverrides": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VoiceLocaleOverride"
      }
    },
    "pronunciationDictionary": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/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": "#/components/schemas/BackgroundAudioSettings"
        }
      ]
    },
    "audioSync": {
      "type": "boolean"
    },
    "keypadInput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceKeypadSettings"
        }
      ]
    },
    "silenceTimeoutMs": {
      "type": "number"
    },
    "maxDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceMaxDurationSettings"
        }
      ]
    },
    "callerIdentity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionSettingsVoiceCallerIdentity"
        }
      ]
    }
  }
}
```

### VersionSettingsVoiceCallerIdentity

```json
{
  "type": "string",
  "enum": [
    "phone-number",
    "call"
  ],
  "x-enumNames": [
    "PHONE_NUMBER",
    "CALL"
  ]
}
```

### VoiceKeypadSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "delimiter": {
      "maxItems": 2,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DTMFDelimiter"
      }
    },
    "timeoutInSeconds": {
      "type": "number"
    }
  },
  "required": [
    "enabled",
    "delimiter",
    "timeoutInSeconds"
  ]
}
```

### VoiceLocaleOverride

```json
{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "minLength": 1
    },
    "tts": {
      "$ref": "#/components/schemas/VoiceSettings"
    }
  },
  "required": [
    "locale",
    "tts"
  ]
}
```

### VoiceMaxDurationSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "seconds": {
      "nullable": true,
      "type": "number"
    },
    "message": {
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "seconds",
    "message"
  ]
}
```

### VoiceSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/AmazonVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/RimelabsVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/MicrosoftVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/ElevenLabsVoiceSettings"
    }
  ]
}
```
