Zum Inhalt

Einführung: API

Die API der Evoya-Plattform bietet eine nahtlose Integration in bestehende IT-Systeme. Sie ermöglicht den direkten Zugriff auf Funktionen und Daten der Plattform, um Prozessautomatisierungen und individuelle Anwendungsfälle zu unterstützen. Mit der API können Sie die Leistungsfähigkeit der Evoya-Plattform in Ihre eigenen Anwendungen einbinden und passende KI-Lösungen für Ihre Geschäftsanforderungen entwickeln. Den Zugang zu Ihren API-Schlüsseln finden Sie hier.

Nachfolgend sind die beiden Hauptendpunkte der Avaia API aufgeführt: die Agent Invoke API und die Guideline Retrieve API.

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.
  • context (object): Zusätzliche Kontextinformationen, um den Agenten bei der Generierung von Antworten zu unterstützen.

Beispiel für einen Anfragekörper:

{
  "text": "Beispieltext",
  "context": {}
}

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"
}

Guideline Retrieve API

Endpunkt: GET /api/guideline/{guideline_uuid}/

Beschreibung

Dieser Endpunkt ruft Informationen zu einer bestimmten Richtlinie ab, die durch die bereitgestellte UUID identifiziert wird.

Parameter

  • Pfadparameter:
  • guideline_uuid (string, erforderlich): Ein eindeutiger Bezeichner für die abzurufende Richtlinie.

Antwort

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

Antwortkörper:

  • name (string): Der Name der Richtlinie.
  • description (string): Eine kurze Beschreibung der Richtlinie.
  • content (string): Detaillierter Inhalt der Richtlinie.

Beispiel für eine Antwort:

{
  "name": "Richtlinienname",
  "description": "Kurze Beschreibung der Richtlinie",
  "content": "Detaillierter Inhalt der Richtlinie"
}

Nutzung

Jeder Endpunkt unterstützt eine Try it out-Funktion zum Testen innerhalb der Swagger UI-Oberfläche. Verwenden Sie diese Funktion, um Anfragen zu simulieren und Echtzeitantworten von der API anzuzeigen.