Zum Inhalt
Platform

Agent Invoke API

Endpunkt: POST /api/agent/{agent_uuid}/invoke/

Beschreibung

Dieser Endpunkt ermöglicht es Benutzern, einen Agenten aufzurufen, um spezifische Aktionen basierend auf dem bereitgestellten Eingabetext und Kontext auszuführen.

Parameter

  • Pfadparameter:
  • agent_uuid (string, erforderlich): Ein eindeutiger Bezeichner für den Agenten, den Sie aufrufen möchten.

  • Anfragekörper (application/json, erforderlich):

  • text (string): Der Eingabetext, der vom Agenten verarbeitet werden soll.
  • payload (object): Zusätzliche Kontextinformationen, um den Agenten bei der Generierung von Antworten zu unterstützen.

Beispiel für einen Anfragekörper:

{
  "text": "Beispieltext",
  "payload": {}
}

Beispiel-Anfragekörper 2 (Neues Beispiel mit Nutzlastdaten):

Agentenaufforderung:

Du bist {name} und du bist {age} Jahre alt. Sage das dem Benutzer. API-Aufruf mit Nutzlast

{
  "text": "",
  "payload": {"name": "John", "age": 48}
}

Antwort

  • Statuscode: 200 OK
  • Content-Type: application/json

Antwortkörper:

  • answer (string): Die Antwort des Agenten auf den Eingabetext.
  • duration (string): Die Zeit, die zur Bearbeitung der Anfrage benötigt wurde.
  • token (string): Ein für die Sitzung oder Aktion generiertes Token.

Beispiel für einen Antwortkörper:

{
 "answer": "Antwort vom Agenten",
  "duration": "100ms",
  "token": "xyz123"
}

Beispiel-Antwortkörper 2:

{
  "answer": "Hello! I'm John, and I'm 48 years old. How can I assist you today?",
  "duration": "1.15 seconds"
}