Models and voices

Use an API key or REST OAuth access token. Scopes and your current workspace permissions apply together. All examples are illustrative.

Read Agent configuration catalog

GET /api/external/v1/agent-catalog

Scope: agents:configuration:read

Use values from this catalog; available models and voices depend on current permissions and configured providers.

Response 200

Success.

Header	Type	Description
Cache-Control	string	The response must not be cached. Example: no-store

application/json

FieldsExample

Field	Type	Description
models	List of object	Models available with the current user's permissions.
languages	List of object	Supported languages.
agentTypes	List of string	Agent types available for configuration. Values: AGENTIC, VOICE
sttProviders	List of string	Available speech-recognition providers. Values: AZURE, DEEPGRAM, KUGEL
ttsProviders	List of string	Available speech-output providers. Values: AZURE, KUGEL
ttsStreamingModes	List of string	Available speech-output modes. Values: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM
deepgramLanguageHints	List of string	Language hints from the Agent catalog. They guide Deepgram without restricting its supported languages. Show all 10 allowed values de, en, es, fr, hi, it, ja, nl, pt, ru
decisionQueryTransformAvailable	boolean	Whether decision-based knowledge search is available.
promptVariables	List of object	Prompt variables supported by this configuration.
kugelLanguages	List of string	Ordered Kugel language codes from the Agent catalog. The first is the expected starting language. Defaults to German on creation; omission on update keeps the current list.
kugelTurnDetectionLevels	List of string	Available Kugel turn-detection settings. Values: RESPONSIVE, CONSERVATIVE

models — fields

Field	Type	Description
value	string	Exact catalog value to send in API requests. Show all 19 allowed values GPT_6_1_SOL, GPT_6_1_TERRA, GPT_6_SOL, GPT_6_LUNA, GPT_5_6_SOL, GPT_5_6_TERRA, GPT_5_6_LUNA, GPT_5, GPT_5_MINI, GPT_5_NANO, GPT_5_4, GPT_5_4_MINI, GPT_5_4_NANO, GPT_4_1, GPT_4_1_MINI, GPT_4_1_NANO, DEEPSEEK_V4_FLASH, MISTRAL_LARGE_3, MICROSOFT_DECISION_1
reasoningEfforts	List of string	Reasoning settings supported by this model. Rules: no duplicates Values: NONE, MINIMAL, LOW
fixedTemperature	number (double)	Temperature required by this model, if fixed.
maxOutputTokens	integer (int32)	Maximum output-token budget supported by this model.
supportsQueryRewrite	boolean	Whether this model supports query rewriting.

languages — fields

Field	Type	Description
value	string	Exact catalog value to send in API requests.
label	string	Display label for this value or variable.

promptVariables — fields

Field	Type	Description
key	string	Name of the variable or parameter.
label	string	Display label for this value or variable.
helperText	string	Explanation of how to use the prompt variable.
category	string	Category used to group prompt variables. Values: AGENT, ROUTING

{
  "models": [],
  "languages": [],
  "agentTypes": [],
  "sttProviders": [],
  "ttsProviders": [],
  "ttsStreamingModes": [],
  "deepgramLanguageHints": [],
  "decisionQueryTransformAvailable": false,
  "promptVariables": [],
  "kugelLanguages": [],
  "kugelTurnDetectionLevels": []
}

Error responses

Status	Meaning
400	Invalid input, unsupported selection or time range.
401	Missing, expired or invalid credential. The body may be empty.
403	Required scope or current user permission missing. The body may be empty.
429	Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503	Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field	Type	Description
status	integer	HTTP status code.
error	string	Description of the error.
details	any	Additional error details, when available. Rules: null allowed
code	string	Machine-readable error code.
params	object	Additional values associated with the error code.
fieldErrors	object	Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

Find available voices

GET /api/external/v1/agent-catalog/voices

Scope: agents:configuration:read

Use values from this catalog; available models and voices depend on current permissions and configured providers. Empty, duplicate or unknown filters are rejected.

Parameters

Name	Location	Type	Required	Description
page	Query	integer (int32)	No	Page index, starting at 0. Rules: 0–100000 Default: 0
size	Query	integer (int32)	No	Results per page. Rules: 1–100 Default: 25
provider	Query	string	No	Return voices from this provider. Values: AZURE, KUGEL
gender	Query	string	No	Filter by the voice's gender category. Values: FEMALE, MALE, NEUTRAL
language	Query	string	No	Language or locale: de includes regional variants; de-DE matches that exact listed locale.
search	Query	string	No	Search voice names and descriptions, ignoring case. Up to 200 characters.

Response 200

Success.

Header	Type	Description
Cache-Control	string	The response must not be cached. Example: no-store

application/json

FieldsExample

Field	Type	Description
items	List of object	Results on this page.
page	integer (int32)	Current page index, starting at 0.
size	integer (int32)	Number of results requested per page.
totalElements	integer (int64)	Total number of matching results.
totalPages	integer (int32)	Total number of result pages.

items — fields

Field	Type	Description
id	string	Voice ID including its provider prefix. Copy unchanged into voiceId.
provider	string	Provider of this voice. Values: AZURE, KUGEL
name	string	Display name.
description	string	Description of the voice supplied by its provider.
languages	List of string	Supported languages.
gender	string	Voice gender as listed by the provider. Values: FEMALE, MALE, NEUTRAL
styles	List of string	Speaking styles supported by this voice.
capabilities	object	Pronunciation and speech-markup features supported by this voice.

capabilities — fields

Field	Type	Description
phoneme	boolean	Whether the voice supports phoneme-based pronunciation.
lexiconAlias	boolean	Whether the voice supports pronunciation aliases.
languageOverride	boolean	Whether the voice supports a language or accent override.
breaks	boolean	Whether the voice supports SSML pauses.
sayAs	boolean	Whether the voice supports SSML say-as formatting.

{
  "items": [
    {
      "id": "azure:FLORIAN_HD",
      "provider": "AZURE",
      "name": "NuvoCar",
      "description": "string",
      "languages": [],
      "gender": "FEMALE",
      "styles": [],
      "capabilities": {
        "phoneme": false,
        "lexiconAlias": false,
        "languageOverride": false,
        "breaks": false,
        "sayAs": false
      }
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}

Error responses

Status	Meaning
400	Invalid input, unsupported selection or time range.
401	Missing, expired or invalid credential. The body may be empty.
403	Required scope or current user permission missing. The body may be empty.
429	Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503	Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field	Type	Description
status	integer	HTTP status code.
error	string	Description of the error.
details	any	Additional error details, when available. Rules: null allowed
code	string	Machine-readable error code.
params	object	Additional values associated with the error code.
fieldErrors	object	Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.