assistant

GET /v1/assistant/conversations/{conversationId}

Read one conversation with its full thread.

すべての assistant エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/assistant/conversations/{conversationId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

⛔ A colleague's conversation is a `404`, never a `403` — a `403` confirms the id exists, which is itself information about what a colleague has asked.

パラメータ

名前タイプ必須これがその内容です
conversationId (path)UuidはいThe conversation's id.

返信

名前タイプ必須これがその内容です
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はい
messagesAssistantMessage[]はい
proposalsAgentProposal[]はいActions the assistant suggested in this thread. **Nothing here has happened** — a proposal is a suggestion with a confirm button, and it is applied only by `POST /v1/ai/proposal…

このエンドポイントが返すエラー

401 · 403 · 404 · 429