Authentication
Send an API key as a bearer token. The key must carry the tickets.reply permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/assistant/conversations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Creates an empty thread. Nothing is sent to a model until you post a message. Requires `tickets.reply`.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | Uuid | No | Required only when you can act in more than one organization. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | Yes | The first question, truncated, so a list of threads is readable. |
escalated_ticket_id | Uuid | Yes | Set once this thread became a support ticket. |
created_at | string | Yes | — |
updated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429