Übersicht

Die Chat-API erleichtert den Abruf von Chatbots und ermöglicht es Nutzern, mit ihnen zu interagieren, indem sie Nachrichten schreiben.

Basis-URL

https://app.openspokenai.com/api

Authentifizierung

Clients müssen sich bei jeder Anfrage mit einem Basic Authorization-Header authentifizieren:

Autorisierung: Basic {authString}

Dabei ist {authString} die base64-kodierte Zeichenfolge des Formats Benutzername:Passwort.

Beispiel für die Verwendung: 

curl -X GET "https://app.openspokenai.com/api/chat" -H "Authorization: Basic {authString}"

Endpunkte

GET /chat

Ruft eine Liste der aktiven Chats ab, die für eine Interaktion zur Verfügung stehen.

Abfrage-Parameter:

Gruppe (optional): Chats nach einer bestimmten Gruppe filtern.

Erfolgreiche Antwort:

{

    "Nachricht": "Erfolg",

    "Daten": [

        {

            "Name": "string",

            "chat_code": "string",

            "Beschreibung": "string",

            "Gruppe": "string"

        }

    ]

}

Kein Inhalt gefunden:

{

    "Meldung": "Fehler",

    "Daten": {

        "Nachricht": "Kein Chatbot für die angegebene Gruppe gefunden."

    }

}

POST /chat

Senden Sie eine Nachricht an einen bestimmten Chat und erhalten Sie eine Antwort.

Überschriften:

Inhalt-Typ: application/json

Autorisierung: Basic {authString}

Erforderliche Nutzlast:

prompt: (string) Der Eingabetext für die Chat-Antwort.

request_id: (string) Eine eindeutige ID, um die Anfrage zu verfolgen.

webhook_url (optional): (URL) Der Endpunkt, an den die Antwort per Webhook gesendet werden soll.

Erfolgreiche Antwort:

{

    "Nachricht": "Erfolg",

    "Daten": {

        "request_id": "string",

        "Nachricht": "string"

    }

}

Antworten auf Fehler:

Unzureichende Kredite:

{

    "Meldung": "Fehler",

    "Daten": {

        "Nachricht": "Sie haben kein Guthaben mehr, um Wörter zu erzeugen. Bitte laden Sie Ihr Guthaben auf und versuchen Sie es erneut."

    }

}

Chatbot nicht gefunden:

{

    "Meldung": "Fehler",

    "Daten": {

        "Nachricht": "Chatbot nicht gefunden."

    }

}

Webhook-Fehler:

{

    "Meldung": "Fehler",

    "Daten": {

        "Nachricht": "Antwort an Webhook konnte nicht gesendet werden".

    }

}