assistant

POST /v1/assistant/conversations

Start a new assistant conversation.

Все эндпоинты assistant

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение tickets.reply; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве поля в теле JSON.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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

Тело запроса

ИмяТипОбязательноЧто это
org_idUuidНетRequired only when you can act in more than one organization.

Ответ

ИмяТипОбязательноЧто это
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringДаThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidДаSet once this thread became a support ticket.
created_atstringДа
updated_atstringДа

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 422 · 429