Zum Inhalt

Agent-Tools

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

Tooltypen und Felder lesen

GET /api/external/v1/tool-catalog

Scope: tools:read

Antwort 200

Erfolgreich.

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

application/json

Objekt mit freien Schlüsseln. Werttyp: object.

[]
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.

Vorhandene Credential-Referenzen auflisten

GET /api/external/v1/tool-catalog/credentials

Scope: tools:read

Liefert vorhandene IDs und Namen, keine Secrets. Erfordert Leserechte für Zugangsdaten.

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

Antwort 200

Erfolgreich.

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

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
name string Anzeigename. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "NuvoCar"
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
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.

Freigegebene externe MCP-Tools auflisten

GET /api/external/v1/tool-catalog/mcp-tools

Scope: tools:read

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

Antwort 200

Erfolgreich.

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

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
name string Anzeigename.
description string Beschreibung des freigegebenen externen MCP-Tools.
inputSchema object JSON Schema der vom Tool akzeptierten Eingaben.
Je Wert: object		 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "NuvoCar",
      "description": "string",
      "inputSchema": {}
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
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.

Vorhandene OAuth-Referenzen auflisten

GET /api/external/v1/tool-catalog/oauth-configurations

Scope: tools:read

Liefert vorhandene IDs und Namen, keine Secrets. Erfordert Leserechte für Zugangsdaten.

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

Antwort 200

Erfolgreich.

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

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
name string Anzeigename. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "NuvoCar"
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
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.

Agent-Tool erstellen

POST /api/external/v1/agents/{agentId}/tools

Scope: tools:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Felder für toolType im Tool-Katalog nachschlagen. Credential-Referenzen erfordern zusätzlich Leserechte für Zugangsdaten.

Parameter

Name Position Typ Pflicht Beschreibung
agentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Request-Body · application/json

Verwende genau eine dieser Varianten:

MCP_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: MCP_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
mcpToolId string (uuid) Ja ID eines freigegebenen externen MCP-Tools aus dem Tool-Katalog.
Regeln: höchstens 100000 Zeichen
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
DIRECT_FORWARDING_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: DIRECT_FORWARDING_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
allowDynamicRecipient boolean Nein Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
forwardingInformation object Nein Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
CONFERENCE_FORWARDING_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: CONFERENCE_FORWARDING_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
allowDynamicRecipient boolean Nein Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
forwardingInformation object Nein Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
forwardingTimeout integer Nein Wartezeit auf das Weiterleitungsziel, in Sekunden.
Regeln: 5–120
screeningEnabled boolean Nein Aktiviert die Empfängerprüfung bei der Konferenzweiterleitung.
machineDetectionEnabled boolean Nein Aktiviert die Anrufbeantwortererkennung bei der Konferenzweiterleitung.
screeningSummaryPrompt string Nein Anweisungen für die Gesprächszusammenfassung bei der Empfängerprüfung.
Regeln: höchstens 100000 Zeichen
announcementPrompt string Nein Anweisungen für die Ansage bei der Weiterleitung.
Regeln: höchstens 100000 Zeichen
EMAIL_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: EMAIL_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
email_to Liste von string Nein Hinterlegte E-Mail-Empfänger.
Regeln: höchstens 100 Einträge
Je Eintrag: höchstens 320 Zeichen
allow_ai_to_recipients boolean Nein Erlaubt dem Agent, E-Mail-Empfänger anzugeben.
email_cc Liste von string Nein E-Mail-Adressen der CC-Empfänger.
Regeln: höchstens 100 Einträge
Je Eintrag: höchstens 320 Zeichen
email_prompt string Ja Anweisungen zum Erstellen des E-Mail-Inhalts.
Regeln: höchstens 100000 Zeichen
email_subject string Ja Betreff der E-Mail.
Regeln: höchstens 100000 Zeichen
include_facts boolean Nein Bezieht erfasste Gesprächsfakten beim Erstellen der E-Mail ein.
include_conversation_history boolean Nein Bezieht den Gesprächsverlauf beim Erstellen der E-Mail ein.
SMS_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: SMS_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
sender_id string Ja Absenderkennung für ausgehende SMS.
Regeln: höchstens 100000 Zeichen
body_mode string Ja Legt fest, wie der SMS-Text entsteht.
Regeln: höchstens 100000 Zeichen
Werte: AGENT_PROVIDED, STATIC, TEMPLATE
static_body string Nein Fester SMS-Text für den Modus STATIC.
Regeln: höchstens 100000 Zeichen
body_template string Nein Vorlage für den SMS-Text.
Regeln: höchstens 100000 Zeichen
WEB_SEARCH_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: WEB_SEARCH_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
searchContext string Nein Kontext, der dem Agent beim Formulieren der Websuche hilft.
Regeln: höchstens 100000 Zeichen
allowedDomains string Nein Domainfilter für die Websuche.
Regeln: höchstens 100000 Zeichen
searchLanguage string Ja Sprache der Websuche.
Regeln: höchstens 100000 Zeichen
Werte: de, en, es, fr, nl
country string Ja Land zur regionalen Ausrichtung der Websuchergebnisse.
Regeln: höchstens 100000 Zeichen
Alle 11 erlaubten Werte anzeigen

AT, AU, BE, CA, CH, DE, ES, FR, GB, NL, US
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
maximumTokens integer Ja Tokenbudget für Websuchergebnisse.
Regeln: 0–30000
maximumSources integer Ja Maximale Anzahl der Quellen für Websuchergebnisse.
Regeln: 0–30000
timeoutMs integer Ja Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000
API_REQUEST_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: API_REQUEST_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
httpMethod string Ja HTTP-Methode des API-Tools.
Regeln: höchstens 100000 Zeichen
Werte: GET, POST, PUT, DELETE
targetUrl string Ja Ziel-URL des API-Tools.
Regeln: höchstens 100000 Zeichen
headers Liste von object Nein HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen.
oauthConfigId string (uuid) Nein ID einer vorhandenen OAuth-Verknüpfung, die der aktuelle Benutzer lesen darf.
Regeln: höchstens 100000 Zeichen
contentType string Nein Content-Type des ausgehenden Request-Bodys.
Regeln: höchstens 100000 Zeichen
Werte: application/json, application/x-www-form-urlencoded, text/plain
defaultBody string Nein Ausgangswert für den Request-Body des Tools.
Regeln: höchstens 100000 Zeichen
inputSchema string Nein JSON Schema für Agent-Eingaben, als Zeichenfolge übergeben.
Regeln: höchstens 100000 Zeichen
responseProcessingMode string Nein Legt fest, wie das API-Tool die Antwort verarbeitet.
Regeln: höchstens 100000 Zeichen
Werte: ORIGINAL, PATHS, SCRIPT
responseScript string Nein Skript zur Umformung der externen Antwort.
Regeln: höchstens 100000 Zeichen
responseMappings object Nein Ordnet Antwortwerte benannten Ausgabefeldern zu.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
timeoutMs integer Nein Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000
runAsync boolean Nein Führt die API-Tool-Aktion asynchron aus.
headers — Felder
Feld Typ Pflicht Beschreibung
name string Ja Name des HTTP-Headers, etwa Authorization.
Regeln: höchstens 200 Zeichen
value string Nein Neuer Headerwert. Auslassen behält den gespeicherten Wert bei unverändertem Ziel.
Regeln: höchstens 8192 Zeichen; nur schreibbar
configured boolean Nein Ein Wert ist gespeichert. true ohne value behält ihn bei unverändertem Ziel.
credentialId string (uuid) Nein ID eines vorhandenen Credentials, das der aktuelle Benutzer lesen darf.
prefix string Nein Präfix vor dem Credential-Wert einschließlich Leerzeichen. Für Bearer-Authentifizierung Bearer mit folgendem Leerzeichen verwenden.
Regeln: höchstens 100 Zeichen		 
{
  "toolType": "API_REQUEST_TOOL",
  "configuration": {
    "displayName": "Service lookup",
    "executionDescription": "Look up a service request when the caller provides its reference.",
    "httpMethod": "GET",
    "targetUrl": "https://service.example.com/status",
    "headers": [],
    "callerMessageEnabled": false,
    "timeoutMs": 5000
  }
}

Antwort 201

Erstellt.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
Location string Pfad der erstellten Ressource.
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Die Antwort entspricht ihrem toolType:

MCP_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: MCP_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
mcpToolId string (uuid) ID eines freigegebenen externen MCP-Tools aus dem Tool-Katalog.
Regeln: höchstens 100000 Zeichen; null erlaubt
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
DIRECT_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: DIRECT_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
CONFERENCE_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: CONFERENCE_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
forwardingTimeout integer Wartezeit auf das Weiterleitungsziel, in Sekunden.
Regeln: 5–120; null erlaubt
screeningEnabled boolean Aktiviert die Empfängerprüfung bei der Konferenzweiterleitung.
Regeln: null erlaubt
machineDetectionEnabled boolean Aktiviert die Anrufbeantwortererkennung bei der Konferenzweiterleitung.
Regeln: null erlaubt
screeningSummaryPrompt string Anweisungen für die Gesprächszusammenfassung bei der Empfängerprüfung.
Regeln: höchstens 100000 Zeichen; null erlaubt
announcementPrompt string Anweisungen für die Ansage bei der Weiterleitung.
Regeln: höchstens 100000 Zeichen; null erlaubt
EMAIL_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: EMAIL_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_to Liste von string Hinterlegte E-Mail-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
allow_ai_to_recipients boolean Erlaubt dem Agent, E-Mail-Empfänger anzugeben.
Regeln: null erlaubt
email_cc Liste von string E-Mail-Adressen der CC-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
email_prompt string Anweisungen zum Erstellen des E-Mail-Inhalts.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_subject string Betreff der E-Mail.
Regeln: höchstens 100000 Zeichen; null erlaubt
include_facts boolean Bezieht erfasste Gesprächsfakten beim Erstellen der E-Mail ein.
Regeln: null erlaubt
include_conversation_history boolean Bezieht den Gesprächsverlauf beim Erstellen der E-Mail ein.
Regeln: null erlaubt
SMS_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: SMS_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
sender_id string Absenderkennung für ausgehende SMS.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_mode string Legt fest, wie der SMS-Text entsteht.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: AGENT_PROVIDED, STATIC, TEMPLATE
static_body string Fester SMS-Text für den Modus STATIC.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_template string Vorlage für den SMS-Text.
Regeln: höchstens 100000 Zeichen; null erlaubt
WEB_SEARCH_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: WEB_SEARCH_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchContext string Kontext, der dem Agent beim Formulieren der Websuche hilft.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowedDomains string Domainfilter für die Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchLanguage string Sprache der Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: de, en, es, fr, nl
country string Land zur regionalen Ausrichtung der Websuchergebnisse.
Regeln: höchstens 100000 Zeichen; null erlaubt
Alle 11 erlaubten Werte anzeigen

AT, AU, BE, CA, CH, DE, ES, FR, GB, NL, US
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
maximumTokens integer Tokenbudget für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
maximumSources integer Maximale Anzahl der Quellen für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
API_REQUEST_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: API_REQUEST_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
httpMethod string HTTP-Methode des API-Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: GET, POST, PUT, DELETE
targetUrl string Ziel-URL des API-Tools.
Regeln: höchstens 100000 Zeichen
headers Liste von object HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen.
oauthConfigId string (uuid) ID einer vorhandenen OAuth-Verknüpfung, die der aktuelle Benutzer lesen darf.
Regeln: höchstens 100000 Zeichen; null erlaubt
contentType string Content-Type des ausgehenden Request-Bodys.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: application/json, application/x-www-form-urlencoded, text/plain
defaultBody string Ausgangswert für den Request-Body des Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
inputSchema string JSON Schema für Agent-Eingaben, als Zeichenfolge übergeben.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseProcessingMode string Legt fest, wie das API-Tool die Antwort verarbeitet.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: ORIGINAL, PATHS, SCRIPT
responseScript string Skript zur Umformung der externen Antwort.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseMappings object Ordnet Antwortwerte benannten Ausgabefeldern zu.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
runAsync boolean Führt die API-Tool-Aktion asynchron aus.
Regeln: null erlaubt
headers — Felder
Feld Typ Beschreibung
name string Name des HTTP-Headers, etwa Authorization.
Regeln: höchstens 200 Zeichen
configured boolean Ein Wert ist gespeichert. true ohne value behält ihn bei unverändertem Ziel.
credentialId string (uuid) ID eines vorhandenen Credentials, das der aktuelle Benutzer lesen darf.
prefix string Präfix vor dem Credential-Wert einschließlich Leerzeichen. Für Bearer-Authentifizierung Bearer mit folgendem Leerzeichen verwenden.
Regeln: höchstens 100 Zeichen		 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "revision": "revision-from-get",
  "toolType": "MCP_TOOL",
  "configuration": {
    "mcpToolId": "00000000-0000-0000-0000-000000000001",
    "callerMessageEnabled": false
  }
}
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.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.

Agent-Tools auflisten

GET /api/external/v1/agents/{agentId}/tools

Scope: tools:read

Parameter

Name Position Typ Pflicht Beschreibung
agentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
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

Antwort 200

Erfolgreich.

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

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Alle 7 erlaubten Werte anzeigen

MCP_TOOL, DIRECT_FORWARDING_TOOL, CONFERENCE_FORWARDING_TOOL, EMAIL_TOOL, SMS_TOOL, WEB_SEARCH_TOOL, API_REQUEST_TOOL
name string Anzeigename. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "revision": "revision-from-get",
      "toolType": "MCP_TOOL",
      "name": "NuvoCar"
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
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.
404 Ressource im gebundenen Workspace nicht verfügbar.
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.

Agent-Tool löschen

DELETE /api/external/v1/agents/{agentId}/tools/{id}

Scope: tools:write

Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden.

Parameter

Name Position Typ Pflicht Beschreibung
agentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
If-Match Header string Ja ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen.
Beispiel: "revision-from-get"

Antwort 204

Gelöscht; kein Response-Body.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
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.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.

Agent-Tool abrufen

GET /api/external/v1/agents/{agentId}/tools/{id}

Scope: tools:read

Parameter

Name Position Typ Pflicht Beschreibung
agentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Die Antwort entspricht ihrem toolType:

MCP_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: MCP_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
mcpToolId string (uuid) ID eines freigegebenen externen MCP-Tools aus dem Tool-Katalog.
Regeln: höchstens 100000 Zeichen; null erlaubt
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
DIRECT_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: DIRECT_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
CONFERENCE_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: CONFERENCE_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
forwardingTimeout integer Wartezeit auf das Weiterleitungsziel, in Sekunden.
Regeln: 5–120; null erlaubt
screeningEnabled boolean Aktiviert die Empfängerprüfung bei der Konferenzweiterleitung.
Regeln: null erlaubt
machineDetectionEnabled boolean Aktiviert die Anrufbeantwortererkennung bei der Konferenzweiterleitung.
Regeln: null erlaubt
screeningSummaryPrompt string Anweisungen für die Gesprächszusammenfassung bei der Empfängerprüfung.
Regeln: höchstens 100000 Zeichen; null erlaubt
announcementPrompt string Anweisungen für die Ansage bei der Weiterleitung.
Regeln: höchstens 100000 Zeichen; null erlaubt
EMAIL_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: EMAIL_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_to Liste von string Hinterlegte E-Mail-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
allow_ai_to_recipients boolean Erlaubt dem Agent, E-Mail-Empfänger anzugeben.
Regeln: null erlaubt
email_cc Liste von string E-Mail-Adressen der CC-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
email_prompt string Anweisungen zum Erstellen des E-Mail-Inhalts.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_subject string Betreff der E-Mail.
Regeln: höchstens 100000 Zeichen; null erlaubt
include_facts boolean Bezieht erfasste Gesprächsfakten beim Erstellen der E-Mail ein.
Regeln: null erlaubt
include_conversation_history boolean Bezieht den Gesprächsverlauf beim Erstellen der E-Mail ein.
Regeln: null erlaubt
SMS_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: SMS_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
sender_id string Absenderkennung für ausgehende SMS.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_mode string Legt fest, wie der SMS-Text entsteht.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: AGENT_PROVIDED, STATIC, TEMPLATE
static_body string Fester SMS-Text für den Modus STATIC.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_template string Vorlage für den SMS-Text.
Regeln: höchstens 100000 Zeichen; null erlaubt
WEB_SEARCH_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: WEB_SEARCH_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchContext string Kontext, der dem Agent beim Formulieren der Websuche hilft.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowedDomains string Domainfilter für die Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchLanguage string Sprache der Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: de, en, es, fr, nl
country string Land zur regionalen Ausrichtung der Websuchergebnisse.
Regeln: höchstens 100000 Zeichen; null erlaubt
Alle 11 erlaubten Werte anzeigen

AT, AU, BE, CA, CH, DE, ES, FR, GB, NL, US
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
maximumTokens integer Tokenbudget für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
maximumSources integer Maximale Anzahl der Quellen für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
API_REQUEST_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: API_REQUEST_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
httpMethod string HTTP-Methode des API-Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: GET, POST, PUT, DELETE
targetUrl string Ziel-URL des API-Tools.
Regeln: höchstens 100000 Zeichen
headers Liste von object HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen.
oauthConfigId string (uuid) ID einer vorhandenen OAuth-Verknüpfung, die der aktuelle Benutzer lesen darf.
Regeln: höchstens 100000 Zeichen; null erlaubt
contentType string Content-Type des ausgehenden Request-Bodys.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: application/json, application/x-www-form-urlencoded, text/plain
defaultBody string Ausgangswert für den Request-Body des Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
inputSchema string JSON Schema für Agent-Eingaben, als Zeichenfolge übergeben.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseProcessingMode string Legt fest, wie das API-Tool die Antwort verarbeitet.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: ORIGINAL, PATHS, SCRIPT
responseScript string Skript zur Umformung der externen Antwort.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseMappings object Ordnet Antwortwerte benannten Ausgabefeldern zu.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
runAsync boolean Führt die API-Tool-Aktion asynchron aus.
Regeln: null erlaubt
headers — Felder
Feld Typ Beschreibung
name string Name des HTTP-Headers, etwa Authorization.
Regeln: höchstens 200 Zeichen
configured boolean Ein Wert ist gespeichert. true ohne value behält ihn bei unverändertem Ziel.
credentialId string (uuid) ID eines vorhandenen Credentials, das der aktuelle Benutzer lesen darf.
prefix string Präfix vor dem Credential-Wert einschließlich Leerzeichen. Für Bearer-Authentifizierung Bearer mit folgendem Leerzeichen verwenden.
Regeln: höchstens 100 Zeichen		 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "revision": "revision-from-get",
  "toolType": "MCP_TOOL",
  "configuration": {
    "mcpToolId": "00000000-0000-0000-0000-000000000001",
    "callerMessageEnabled": false
  }
}
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.
404 Ressource im gebundenen Workspace nicht verfügbar.
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.

Agent-Tool ändern

PUT /api/external/v1/agents/{agentId}/tools/{id}

Scope: tools:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden. Vollständige bearbeitbare Konfiguration senden. Ausgelassene Einstellungen können zurückgesetzt werden. Felder für toolType im Tool-Katalog nachschlagen. Credential-Referenzen erfordern zusätzlich Leserechte für Zugangsdaten.

Parameter

Name Position Typ Pflicht Beschreibung
agentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
If-Match Header string Ja ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen.
Beispiel: "revision-from-get"

Request-Body · application/json

Verwende genau eine dieser Varianten:

MCP_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: MCP_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
mcpToolId string (uuid) Ja ID eines freigegebenen externen MCP-Tools aus dem Tool-Katalog.
Regeln: höchstens 100000 Zeichen
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
DIRECT_FORWARDING_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: DIRECT_FORWARDING_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
allowDynamicRecipient boolean Nein Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
forwardingInformation object Nein Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
CONFERENCE_FORWARDING_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: CONFERENCE_FORWARDING_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
allowDynamicRecipient boolean Nein Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
forwardingInformation object Nein Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
forwardingTimeout integer Nein Wartezeit auf das Weiterleitungsziel, in Sekunden.
Regeln: 5–120
screeningEnabled boolean Nein Aktiviert die Empfängerprüfung bei der Konferenzweiterleitung.
machineDetectionEnabled boolean Nein Aktiviert die Anrufbeantwortererkennung bei der Konferenzweiterleitung.
screeningSummaryPrompt string Nein Anweisungen für die Gesprächszusammenfassung bei der Empfängerprüfung.
Regeln: höchstens 100000 Zeichen
announcementPrompt string Nein Anweisungen für die Ansage bei der Weiterleitung.
Regeln: höchstens 100000 Zeichen
EMAIL_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: EMAIL_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
email_to Liste von string Nein Hinterlegte E-Mail-Empfänger.
Regeln: höchstens 100 Einträge
Je Eintrag: höchstens 320 Zeichen
allow_ai_to_recipients boolean Nein Erlaubt dem Agent, E-Mail-Empfänger anzugeben.
email_cc Liste von string Nein E-Mail-Adressen der CC-Empfänger.
Regeln: höchstens 100 Einträge
Je Eintrag: höchstens 320 Zeichen
email_prompt string Ja Anweisungen zum Erstellen des E-Mail-Inhalts.
Regeln: höchstens 100000 Zeichen
email_subject string Ja Betreff der E-Mail.
Regeln: höchstens 100000 Zeichen
include_facts boolean Nein Bezieht erfasste Gesprächsfakten beim Erstellen der E-Mail ein.
include_conversation_history boolean Nein Bezieht den Gesprächsverlauf beim Erstellen der E-Mail ein.
SMS_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: SMS_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
sender_id string Ja Absenderkennung für ausgehende SMS.
Regeln: höchstens 100000 Zeichen
body_mode string Ja Legt fest, wie der SMS-Text entsteht.
Regeln: höchstens 100000 Zeichen
Werte: AGENT_PROVIDED, STATIC, TEMPLATE
static_body string Nein Fester SMS-Text für den Modus STATIC.
Regeln: höchstens 100000 Zeichen
body_template string Nein Vorlage für den SMS-Text.
Regeln: höchstens 100000 Zeichen
WEB_SEARCH_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: WEB_SEARCH_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
searchContext string Nein Kontext, der dem Agent beim Formulieren der Websuche hilft.
Regeln: höchstens 100000 Zeichen
allowedDomains string Nein Domainfilter für die Websuche.
Regeln: höchstens 100000 Zeichen
searchLanguage string Ja Sprache der Websuche.
Regeln: höchstens 100000 Zeichen
Werte: de, en, es, fr, nl
country string Ja Land zur regionalen Ausrichtung der Websuchergebnisse.
Regeln: höchstens 100000 Zeichen
Alle 11 erlaubten Werte anzeigen

AT, AU, BE, CA, CH, DE, ES, FR, GB, NL, US
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
maximumTokens integer Ja Tokenbudget für Websuchergebnisse.
Regeln: 0–30000
maximumSources integer Ja Maximale Anzahl der Quellen für Websuchergebnisse.
Regeln: 0–30000
timeoutMs integer Ja Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000
API_REQUEST_TOOL
Feld Typ Pflicht Beschreibung
toolType string Ja Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: API_REQUEST_TOOL
configuration object Ja Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Pflicht Beschreibung
displayName string Ja Anzeigename des Tools.
Regeln: höchstens 255 Zeichen
executionDescription string Ja Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen
httpMethod string Ja HTTP-Methode des API-Tools.
Regeln: höchstens 100000 Zeichen
Werte: GET, POST, PUT, DELETE
targetUrl string Ja Ziel-URL des API-Tools.
Regeln: höchstens 100000 Zeichen
headers Liste von object Nein HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen.
oauthConfigId string (uuid) Nein ID einer vorhandenen OAuth-Verknüpfung, die der aktuelle Benutzer lesen darf.
Regeln: höchstens 100000 Zeichen
contentType string Nein Content-Type des ausgehenden Request-Bodys.
Regeln: höchstens 100000 Zeichen
Werte: application/json, application/x-www-form-urlencoded, text/plain
defaultBody string Nein Ausgangswert für den Request-Body des Tools.
Regeln: höchstens 100000 Zeichen
inputSchema string Nein JSON Schema für Agent-Eingaben, als Zeichenfolge übergeben.
Regeln: höchstens 100000 Zeichen
responseProcessingMode string Nein Legt fest, wie das API-Tool die Antwort verarbeitet.
Regeln: höchstens 100000 Zeichen
Werte: ORIGINAL, PATHS, SCRIPT
responseScript string Nein Skript zur Umformung der externen Antwort.
Regeln: höchstens 100000 Zeichen
responseMappings object Nein Ordnet Antwortwerte benannten Ausgabefeldern zu.
Regeln: höchstens 100 Schlüssel
Je Wert: string; höchstens 4000 Zeichen
callerMessageEnabled boolean Nein Kündigt die Tool-Aktion gegenüber dem Anrufer an.
timeoutMs integer Nein Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000
runAsync boolean Nein Führt die API-Tool-Aktion asynchron aus.
headers — Felder
Feld Typ Pflicht Beschreibung
name string Ja Name des HTTP-Headers, etwa Authorization.
Regeln: höchstens 200 Zeichen
value string Nein Neuer Headerwert. Auslassen behält den gespeicherten Wert bei unverändertem Ziel.
Regeln: höchstens 8192 Zeichen; nur schreibbar
configured boolean Nein Ein Wert ist gespeichert. true ohne value behält ihn bei unverändertem Ziel.
credentialId string (uuid) Nein ID eines vorhandenen Credentials, das der aktuelle Benutzer lesen darf.
prefix string Nein Präfix vor dem Credential-Wert einschließlich Leerzeichen. Für Bearer-Authentifizierung Bearer mit folgendem Leerzeichen verwenden.
Regeln: höchstens 100 Zeichen		 
{
  "toolType": "API_REQUEST_TOOL",
  "configuration": {
    "displayName": "Service lookup",
    "executionDescription": "Look up a service request when the caller provides its reference.",
    "httpMethod": "GET",
    "targetUrl": "https://service.example.com/status",
    "headers": [],
    "callerMessageEnabled": false,
    "timeoutMs": 5000
  }
}

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Die Antwort entspricht ihrem toolType:

MCP_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: MCP_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
mcpToolId string (uuid) ID eines freigegebenen externen MCP-Tools aus dem Tool-Katalog.
Regeln: höchstens 100000 Zeichen; null erlaubt
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
DIRECT_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: DIRECT_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
CONFERENCE_FORWARDING_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: CONFERENCE_FORWARDING_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowDynamicRecipient boolean Erlaubt dem Agent, ein Weiterleitungsziel dynamisch zu wählen.
Regeln: null erlaubt
forwardingInformation object Weiterleitungsziele mit dem Zielnamen als Schlüssel.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
forwardingTimeout integer Wartezeit auf das Weiterleitungsziel, in Sekunden.
Regeln: 5–120; null erlaubt
screeningEnabled boolean Aktiviert die Empfängerprüfung bei der Konferenzweiterleitung.
Regeln: null erlaubt
machineDetectionEnabled boolean Aktiviert die Anrufbeantwortererkennung bei der Konferenzweiterleitung.
Regeln: null erlaubt
screeningSummaryPrompt string Anweisungen für die Gesprächszusammenfassung bei der Empfängerprüfung.
Regeln: höchstens 100000 Zeichen; null erlaubt
announcementPrompt string Anweisungen für die Ansage bei der Weiterleitung.
Regeln: höchstens 100000 Zeichen; null erlaubt
EMAIL_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: EMAIL_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_to Liste von string Hinterlegte E-Mail-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
allow_ai_to_recipients boolean Erlaubt dem Agent, E-Mail-Empfänger anzugeben.
Regeln: null erlaubt
email_cc Liste von string E-Mail-Adressen der CC-Empfänger.
Regeln: höchstens 100 Einträge; null erlaubt
Je Eintrag: höchstens 320 Zeichen
email_prompt string Anweisungen zum Erstellen des E-Mail-Inhalts.
Regeln: höchstens 100000 Zeichen; null erlaubt
email_subject string Betreff der E-Mail.
Regeln: höchstens 100000 Zeichen; null erlaubt
include_facts boolean Bezieht erfasste Gesprächsfakten beim Erstellen der E-Mail ein.
Regeln: null erlaubt
include_conversation_history boolean Bezieht den Gesprächsverlauf beim Erstellen der E-Mail ein.
Regeln: null erlaubt
SMS_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: SMS_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
sender_id string Absenderkennung für ausgehende SMS.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_mode string Legt fest, wie der SMS-Text entsteht.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: AGENT_PROVIDED, STATIC, TEMPLATE
static_body string Fester SMS-Text für den Modus STATIC.
Regeln: höchstens 100000 Zeichen; null erlaubt
body_template string Vorlage für den SMS-Text.
Regeln: höchstens 100000 Zeichen; null erlaubt
WEB_SEARCH_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: WEB_SEARCH_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchContext string Kontext, der dem Agent beim Formulieren der Websuche hilft.
Regeln: höchstens 100000 Zeichen; null erlaubt
allowedDomains string Domainfilter für die Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
searchLanguage string Sprache der Websuche.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: de, en, es, fr, nl
country string Land zur regionalen Ausrichtung der Websuchergebnisse.
Regeln: höchstens 100000 Zeichen; null erlaubt
Alle 11 erlaubten Werte anzeigen

AT, AU, BE, CA, CH, DE, ES, FR, GB, NL, US
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
maximumTokens integer Tokenbudget für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
maximumSources integer Maximale Anzahl der Quellen für Websuchergebnisse.
Regeln: 0–30000; null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
API_REQUEST_TOOL
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
revision string Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden.
toolType string Tooltyp aus dem Tool-Katalog. Nach dem Anlegen unveränderlich.
Werte: API_REQUEST_TOOL
configuration object Einstellungen dieser Ressource. Beim Ändern die vollständige bearbeitbare Konfiguration senden.
configuration — Felder
Feld Typ Beschreibung
displayName string Anzeigename des Tools.
Regeln: höchstens 255 Zeichen; null erlaubt
executionDescription string Beschreibt dem Agent, wann er das Tool verwenden soll und welche Eingaben es benötigt.
Regeln: höchstens 100000 Zeichen; null erlaubt
httpMethod string HTTP-Methode des API-Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: GET, POST, PUT, DELETE
targetUrl string Ziel-URL des API-Tools.
Regeln: höchstens 100000 Zeichen
headers Liste von object HTTP-Request-Header. Gespeicherte Secret-Werte bleiben verborgen.
oauthConfigId string (uuid) ID einer vorhandenen OAuth-Verknüpfung, die der aktuelle Benutzer lesen darf.
Regeln: höchstens 100000 Zeichen; null erlaubt
contentType string Content-Type des ausgehenden Request-Bodys.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: application/json, application/x-www-form-urlencoded, text/plain
defaultBody string Ausgangswert für den Request-Body des Tools.
Regeln: höchstens 100000 Zeichen; null erlaubt
inputSchema string JSON Schema für Agent-Eingaben, als Zeichenfolge übergeben.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseProcessingMode string Legt fest, wie das API-Tool die Antwort verarbeitet.
Regeln: höchstens 100000 Zeichen; null erlaubt
Werte: ORIGINAL, PATHS, SCRIPT
responseScript string Skript zur Umformung der externen Antwort.
Regeln: höchstens 100000 Zeichen; null erlaubt
responseMappings object Ordnet Antwortwerte benannten Ausgabefeldern zu.
Regeln: höchstens 100 Schlüssel; null erlaubt
Je Wert: string; höchstens 4000 Zeichen
callerMessageEnabled boolean Kündigt die Tool-Aktion gegenüber dem Anrufer an.
Regeln: null erlaubt
timeoutMs integer Zeitlimit des ausgehenden Aufrufs, in Millisekunden.
Regeln: 0–30000; null erlaubt
runAsync boolean Führt die API-Tool-Aktion asynchron aus.
Regeln: null erlaubt
headers — Felder
Feld Typ Beschreibung
name string Name des HTTP-Headers, etwa Authorization.
Regeln: höchstens 200 Zeichen
configured boolean Ein Wert ist gespeichert. true ohne value behält ihn bei unverändertem Ziel.
credentialId string (uuid) ID eines vorhandenen Credentials, das der aktuelle Benutzer lesen darf.
prefix string Präfix vor dem Credential-Wert einschließlich Leerzeichen. Für Bearer-Authentifizierung Bearer mit folgendem Leerzeichen verwenden.
Regeln: höchstens 100 Zeichen		 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "revision": "revision-from-get",
  "toolType": "MCP_TOOL",
  "configuration": {
    "mcpToolId": "00000000-0000-0000-0000-000000000001",
    "callerMessageEnabled": false
  }
}
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.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
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.