会話IDの作成

この機能は、conversation_id（ユーザーとエージェント間の会話を識別するID）の生成をリクエストし、取得するために使用されます。ユーザー属性、長期記憶、短期記憶などはすべてこの conversation_id に関連付けられます。

ID	説明
conversation_id	`agent_id` と `user_id` によって一意に生成される会話識別子です。ユーザーとエージェント間での複数ターンの会話に使用されます。1つの `conversation_id` には通常、複数の `message_id` が含まれます。
message_id	`ユーザーが送信したメッセージ`と、`それに対してエージェントが返信したメッセージ`により一意に生成されるメッセージ識別子です。ユーザーとエージェント間の1回のやり取り（往復）を表します。各 `message_id` は必ず1つの `conversation_id` に属します。

リクエストメソッド

POST

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/conversation

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \
  -H 'Authorization: Bearer ${API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_id": "your_user_id"
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json` を設定してください。

リクエストボディ

フィールド	タイプ	必須	説明
user_id	String	必須	エージェント内でユーザーを一意に識別するために開発者が定義するユーザーID。最大32文字まで。

レスポンス

レスポンス例

{ "conversation_id": "657303a8a764d47094874bbe" }

                      
                      {
  "conversation_id": "657303a8a764d47094874bbe" 
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
conversation_id	String	作成された会話の識別ID

エラー時のレスポンス

フィールド	タイプ	説明
code	Int	エラーコード
message	String	エラーの詳細情報

エラーコード

コード	メッセージ
40000	無効なパラメータ
40127	開発者認証に失敗しました
40378	エージェントが削除されています