Set vocabulary
Set the agent's transcription vocabulary specialisation: 'general' (default) or 'medical'. Medical makes the runtime prefer a medical speech recognition variant so clinical vocabulary (medication names, anatomy, procedures) is transcribed more accurately. Agent-scoped (applies across versions), stored on agents.settings.vocabulary. Medical only takes effect on a speech recognition model that has a medical variant; the Hearing page shows which ones do, so switch the agent's model there if it has none. Use when the user says 'this is a medical clinic', 'transcribe medical terms', or 'switch back to general vocabulary'.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/set_vocabulary" \ -H "Content-Type: application/json" \ -d '{ "vocabulary": "general", "agent": "string" }'{}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Set variable default POST
Create or update a DYNAMIC per-agent variable and its default (fallback) value. A dynamic variable's value is expected to be injected at call time (API / test profile); this default is what `{{name}}` resolves to when nothing was injected, so an unset variable renders the default instead of leaving the raw `{{name}}` placeholder in the prompt or tool URL. Use this for greeting personalisation like `customer_name` (default `there`) or `company_name`. For a value stored on the agent itself use `set_plain_variable`; for secrets use `request_secret_variable` in the app (or `set_secret_variable` over the MCP). A name can be plain/secret OR dynamic, never both, pick one at creation. To rename, use `rename_variable`, never delete-and-recreate.
Set voice POST
Set the voice used at runtime (a voice id from list_voices). Pass both the voice id and the human-readable name so the editor displays the latter. Don't guess a voiceId: when the user describes a voice ('warmer Australian woman'), call `list_voices` to get real candidates, let the operator choose one (in the app, through `ask_user`), then set it. Pass voiceProvider from the same list_voices row, since a mismatched id and provider is rejected.