Operations
Operations

Set STT model

Set which speech-to-text engine transcribes the caller on this agent. The STT model is versioned, the write lands on the current draft version (create a draft first if the current version is published). Pass null to clear the override and fall back to the platform default. Unlike the LLM model this affects transcription accuracy, language coverage, and keyterm boosting support, call get_agent (sections: ['model']) first if unsure what's currently set.

POST
/operations/set_stt_model

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

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.

Length1 <= length <= 255

Request 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_stt_model" \  -H "Content-Type: application/json" \  -d '{    "sttModel": "string",    "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
}

Update speech POST

Update the agent's speech and call-audio knobs: voice speed, volume and emotion, carrier-side noise suppression for the caller's inbound audio on phone calls, and browser-mic noise suppression on web calls (test panel, demos, share page). Every field is optional; send only what changes. Use this when the user says things like 'speak slower' (ttsSpeed: 0.85), 'sound more cheerful' (ttsEmotion: 'happy'), 'quieter' (ttsVolume: 0.8), 'clean up background noise on phone calls' (noiseSuppression: one of the engines the field lists, or 'off' to disable), or 'clean up mic noise on web test calls' (noiseSuppressionWeb: true | false). noiseSuppressionStrength (0-100 whole number, default 70) tunes how hard the phone-side engine cleans: lower keeps more natural audio, higher removes more noise but can clip quiet speech and pump; inert when noiseSuppression is 'off' or 'Denoiser'. elTone ('natural' | 'expressive' | 'steady') sets the tone preset on the voices that have one, and applies to no other voice; the default voice engine uses ttsEmotion instead. sttLanguageHints lists the languages callers are expected to speak (codes from en, it, es, fr, de, pt, nl, ru, hi, ja) and only applies to the multilingual speech recognition model (set_stt_model): it biases which language each caller turn is heard as, so a short reply such as 'Va bene' is not heard as Dutch. The agent's voice pronounces each sentence it speaks in whichever listed language that sentence is written in, so list at least two languages for the voice to switch. The default is English; pass [] to return to it. Pass null for a field to unset it, back to the default.

Set message details POST

Declare the details take_a_message records on EVERY message, a property address, a job number, a date, whether or not the caller gives them. Each declared detail becomes a required argument the agent must answer during the call, and its own labelled line in the message email; one the caller will not give is recorded as "not given" instead of being left off. Use this when a team matches messages to jobs or accounts by hand, where a field they can see is workable and a field that simply is not there looks like a complete message about something else. Prefer it over wording the requirement into the system prompt: prose asks the model to remember, this asks the schema. `details` replaces the whole list; pass an empty array to turn it off. The change lands on the draft version.