Modelle und Stimmen¶

Verwende einen API-Schlüssel oder REST-OAuth-Access-Token. Scopes und deine aktuellen Workspace-Rechte gelten gemeinsam. Die Beispiele verwenden fiktive Daten.

Agent-Auswahlkatalog lesen¶

GET /api/external/v1/agent-catalog

Scope: agents:configuration:read

Verwende Werte aus diesem Katalog; Modelle und Stimmen hängen von Berechtigungen und eingerichteten Anbietern ab.

Antwort 200

Erfolgreich.

Header	Typ	Beschreibung
`Cache-Control`	`string`	Die Antwort darf nicht zwischengespeichert werden. Beispiel: `no-store`

application/json

FelderBeispiel

Feld	Typ	Beschreibung
`models`	Liste von `object`	Mit den aktuellen Benutzerrechten verfügbare Modelle.
`languages`	Liste von `object`	Unterstützte Sprachen.
`agentTypes`	Liste von `string`	Verfügbare Agenttypen. Werte: `AGENTIC`, `VOICE`
`sttProviders`	Liste von `string`	Verfügbare Spracherkennungsanbieter. Werte: `AZURE`, `DEEPGRAM`, `KUGEL`
`ttsProviders`	Liste von `string`	Verfügbare Sprachausgabeanbieter. Werte: `AZURE`, `KUGEL`
`ttsStreamingModes`	Liste von `string`	Verfügbare Sprachausgabemodi. Werte: `QUALITY_SSML`, `LOW_LATENCY_TEXT_STREAM`
`deepgramLanguageHints`	Liste von `string`	Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Alle 10 erlaubten Werte anzeigen `de`, `en`, `es`, `fr`, `hi`, `it`, `ja`, `nl`, `pt`, `ru`
`decisionQueryTransformAvailable`	`boolean`	Ob die Wissenssuche mit separatem Suchentscheid verfügbar ist.
`promptVariables`	Liste von `object`	Von dieser Konfiguration unterstützte Prompt-Variablen.
`kugelLanguages`	Liste von `string`	Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste.
`kugelTurnDetectionLevels`	Liste von `string`	Verfügbare Kugel-Einstellungen zur Erkennung des Beitragsendes. Werte: `RESPONSIVE`, `CONSERVATIVE`

models — Felder

Feld	Typ	Beschreibung
`value`	`string`	Exakter Katalogwert für API-Aufrufe. Alle 19 erlaubten Werte anzeigen `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`	Liste von `string`	Vom Modell unterstützte Reasoning-Einstellungen. Regeln: keine doppelten Einträge Werte: `NONE`, `MINIMAL`, `LOW`
`fixedTemperature`	`number` (double)	Vom Modell vorgegebene Temperatur, sofern sie festgelegt ist.
`maxOutputTokens`	`integer` (int32)	Maximales vom Modell unterstütztes Output-Tokenbudget.
`supportsQueryRewrite`	`boolean`	Ob das Modell die Suchumformulierung unterstützt.

languages — Felder

Feld	Typ	Beschreibung
`value`	`string`	Exakter Katalogwert für API-Aufrufe.
`label`	`string`	Anzeigename dieses Werts oder dieser Variablen.

promptVariables — Felder

Feld	Typ	Beschreibung
`key`	`string`	Name der Variablen oder des Parameters.
`label`	`string`	Anzeigename dieses Werts oder dieser Variablen.
`helperText`	`string`	Erläuterung zur Verwendung der Prompt-Variablen.
`category`	`string`	Kategorie zur Gruppierung von Prompt-Variablen. Werte: `AGENT`, `ROUTING`

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

Fehlerantworten

Status	Bedeutung
`400`	Ungültige Eingabe, Auswahl oder Zeitgrenzen.
`401`	Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
`403`	Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
`429`	Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
`503`	Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld	Typ	Beschreibung
`status`	`integer`	HTTP-Statuscode.
`error`	`string`	Beschreibung des Fehlers.
`details`	`any`	Weitere Fehlerdetails, sofern vorhanden. Regeln: `null` erlaubt
`code`	`string`	Maschinenlesbarer Fehlercode.
`params`	`object`	Zusätzliche Werte zum Fehlercode.
`fieldErrors`	`object`	Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Verfügbare Stimmen suchen¶

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

Scope: agents:configuration:read

Verwende Werte aus diesem Katalog; Modelle und Stimmen hängen von Berechtigungen und eingerichteten Anbietern ab. Leere, doppelte oder unbekannte Filter werden abgewiesen.

Parameter

Name	Position	Typ	Pflicht	Beschreibung
`page`	Query	`integer` (int32)	Nein	Seitenindex ab 0. Regeln: `0–100000` Standard: `0`
`size`	Query	`integer` (int32)	Nein	Ergebnisse pro Seite. Regeln: `1–100` Standard: `25`
`provider`	Query	`string`	Nein	Nur Stimmen dieses Anbieters liefern. Werte: `AZURE`, `KUGEL`
`gender`	Query	`string`	Nein	Nach der Stimmkategorie filtern. Werte: `FEMALE`, `MALE`, `NEUTRAL`
`language`	Query	`string`	Nein	Sprache oder Sprachregion: de umfasst regionale Varianten; de-DE erfordert genau diesen Katalogeintrag.
`search`	Query	`string`	Nein	Stimmennamen und Beschreibungen durchsuchen, unabhängig von Groß-/Kleinschreibung. Höchstens 200 Zeichen.