assistant

POST /v1/assistant/conversations

Start a new assistant conversation.

Lahat ng assistant endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na tickets.reply; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Kung saan mapupunta ang id ng iyong organisasyon

Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Katawan ng kahilingan

PangalanUriKailanganAno ito
org_idUuidHindiRequired only when you can act in more than one organization.

Tugon

PangalanUriKailanganAno ito
idUuidOoUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringOoThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidOoSet once this thread became a support ticket.
created_atstringOo
updated_atstringOo

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422 · 429