Unterhaltung erstellen – Conversation ID

Nutzen Sie diese API, um eine eindeutige conversation_id für Unterhaltungen zwischen Nutzer:in und Agent zu generieren. Diese ID dient als eindeutiger Bezeichner für die Konversation und verknüpft Nutzerattribute sowie das Langzeit- und Kurzzeitgedächtnis mit der jeweiligen Unterhaltung.

ID-Name	Beschreibung
conversation_id	Von `agent_id` und `user_id` gemeinsam generierte Unterhaltungs-ID, die für mehrere Dialogrunden zwischen Nutzer:in und Agent verwendet wird. Eine einzelne `conversation_id` umfasst in der Regel mehrere `message_id`s.
message_id	Von Nutzer:innen-Nachrichten und Agent-Antworten gemeinsam generierte Nachrichten-ID. Sie repräsentiert eine einzelne Dialogrunde innerhalb einer Unterhaltung. Die `message_id` gehört immer zu einer `conversation_id`.

Anfrage

HTTP-Methode

POST

Anfrage-URL

https://api-${endpoint}.gptbots.ai/v1/conversation

Authentifizierung

Siehe API-Übersicht für Authentifizierungsanweisungen.

Beispielanfrage

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \
  -H 'Authorization: Bearer ${API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_id": "your_user_id"
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Für die Authentifizierung verwenden Sie Authorization: Bearer ${API Key}. Den API-Schlüssel erhalten Sie auf der API-Key-Seite.
Content-Type	application/json	Datentyp: auf application/json setzen.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
user_id	string	Ja	Vom Entwickler vergebene Nutzer-ID zur eindeutigen Identifikation im Agent. Maximal 32 Zeichen.

Antwort

Beispielantwort

{ "conversation_id": "657303a8a764d47094874bbe" }

                      
                      {
  "conversation_id": "657303a8a764d47094874bbe" 
}

Dieser Codeblock im schwebenden Fenster

Erfolgsantwort

Feld	Typ	Beschreibung
conversation_id	string	Eindeutige ID der Unterhaltung.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode
message	string	Fehlermeldung

Fehlercodes

Code	Fehlermeldung
40000	Parameterfehler
40127	Authentifizierung des Entwicklers fehlgeschlagen
40378	Agent gelöscht