assistant

POST /v1/assistant/conversations

Start a new assistant conversation.

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

認証

ベアラー トークンとして API キーを送信します。キーには tickets.reply 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

組織 ID を入力する場所

このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。

組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。

試してみる

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

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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