Derselbe Berater, der im Kabinett arbeitet, steht auch Ihrer Anwendung offen. Sie legen eine Sitzung an, schicken eine Nachricht, und die Antwort des Assistenten kommt Stück für Stück über einen offenen Strom.
Braucht den Geltungsbereich tools:chat. Grundadresse: https://developers.grem.capital/api/v1.
Wie es arbeitet
- Legen Sie eine Sitzung an - sie hält den Zusammenhang des Gesprächs.
- Öffnen Sie den Strom der Ereignisse für diese Sitzung.
- Schicken Sie eine Nachricht.
- Die Antwort kommt in Stücken über den Strom, bis sie fertig ist.
Die Reihenfolge zählt: Öffnen Sie den Strom bevor Sie die Nachricht schicken, sonst gehen die ersten Stücke der Antwort an Ihnen vorbei.
Sitzungen
POST /chat/sessions create
GET /chat/sessions list
PATCH /chat/sessions/{id} rename, pin
DELETE /chat/sessions/{id} move to the archive
Eine anlegen:
curl -X POST https://developers.grem.capital/api/v1/chat/sessions \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{"title":"Client question about a mortgage"}'
Die Antwort trägt die Kennung der Sitzung, die Sie in jeden folgenden Aufruf übergeben.
Über die API bekommen Sie den allgemeinen Berater. Der Modus des Autoresponders, der im CRM des Kabinetts arbeitet, lässt sich von außen nicht einschalten.
Eine Nachricht schicken
curl -X POST https://developers.grem.capital/api/v1/chat/messages \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "…",
"text": "What does a two-room flat in Podil cost?",
"clientMessageId": "msg-0001"
}'
clientMessageId ist Ihre eigene Kennung der Nachricht. Sie verbindet das Gesendete mit dem, was über den Strom kommt, damit beim Wiederaufbau der Verbindung nichts doppelt erscheint.
Das freiwillige Feld style setzt die Länge der Antwort: short, normal oder detailed.
Der Strom der Antwort
GET /chat/stream?sessionId=…
Authorization: Bearer gsk_live_...
Accept: text/event-stream
Die Verbindung bleibt lange offen, und die Ereignisse kommen, während die Antwort entsteht:
| Ereignis | Was es bedeutet |
|---|---|
assistant.started | der Assistent hat begonnen zu antworten; es folgen Textstücke |
assistant.delta | das nächste Stück Text, im Feld delta |
assistant.done | die Antwort ist vollständig; text enthält sie ganz |
Bricht die Verbindung ab, verbinden Sie sich mit derselben sessionId neu: Der Server spielt den laufenden Zug von vorn ab. Deshalb sollte assistant.started den für diese Nachricht gesammelten Text löschen, sonst verdoppelt er sich.
Verlauf
GET /chat/history?sessionId=…&limit=50
Gibt die gespeicherten Nachrichten der Sitzung zurück. Damit stellen Sie das Gespräch wieder her, wenn Ihre Oberfläche neu lädt.
Was es kostet
Berechnet wird allein das Senden einer Nachricht (POST /chat/messages). Das Anlegen einer Sitzung, die Liste der Sitzungen, der Verlauf und der Strom selbst sind kostenlos und zählen nicht als API-Aufrufe.
Verwandte Artikel
- SDK für TypeScript - ein fertiger Client, der den Strom abonniert.
- Fehler - was die Codes der Ablehnungen bedeuten.
- Werkzeuge über die API - die übrigen Werkzeuge der Plattform.