assistant
POST /v1/assistant/conversations/{conversationId}/messages
Ask the assistant a question and get its answer.
認証
ベアラー トークンとして API キーを送信します。キーには tickets.reply 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/assistant/conversations/{conversationId}/messages \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "question": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Synchronous: one request, two persisted turns, and the answer in the response. ⛔ Not 202 with a poll — §2.16 forbids an interactive path behind a job queue, and a chat that answers on the next poll is not a chat. Expect several seconds. The answer is grounded in published knowledge-base articles and, when site_id names one of your own sites, that site's health as read from our monitoring database. It cannot see another tenant's data, an unpublished draft, or a staff internal note — those are excluded by what the engine fetches, not by asking the model. It cannot act: no tool on this path changes anything. A 503 is a refusal fit to show the customer, and its error_code distinguishes the reasons — ASSISTANT_DAILY_LIMIT, ASSISTANT_DISABLED, ASSISTANT_FAILED, ASSISTANT_UNAVAILABLE. ⭐ Four, not six: an empty or over-long question is refused by validation as a 422 before anything is spent, so its code never reaches this response. Requires tickets.reply.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
conversationId (path) | Uuid | はい | The conversation's id. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
question | string | はい | The customer's question, in their own language. Longer than this is a paste, not a question, and an unbounded prompt is an unbounded bill — so it is a 422. |
site_id | Uuid | いいえ | Which of your sites this is about. ⛔ Validated against your own sites before anything is read — an id from a client is a request, not a fact. |
page_context | string | いいえ | The screen you asked from, as a route path — e.g. /sites/{siteId}/backups. "Why is this failing?" asked on the backups screen and on the DNS screen are different questions, and… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
role | AssistantRole | はい | — |
text | string | はい | — |
cited_slugs | string[] | はい | Knowledge-base slugs the answer used, for /kb/<slug> links. ⭐ Always a subset of what the engine supplied — a slug the model invented is dropped, because a fabricated citation… |
needs_human | boolean | はい | The model's own statement that it could not answer from what it was given. Recorded from its structured output, never inferred from the prose. This is what the "open a ticket"… |
created_at | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503