assistant

POST /v1/assistant/conversations

Start a new assistant conversation.

Alle assistant Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung tickets.reply verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X POST https://api.zinndigital.com/v1/assistant/conversations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Creates an empty thread. Nothing is sent to a model until you post a message. Requires `tickets.reply`.

Anfragekörper

NameTypErforderlichWas es ist
org_idUuidNeinRequired only when you can act in more than one organization.

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringJaThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidJaSet once this thread became a support ticket.
created_atstringJa
updated_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422 · 429