スレッド API¶

この API を使用して、Cortex Agentとのやり取りに使用されるスレッドを作成します。

スレッドを作成する¶

POST /api/v2/cortex/threads

新しいスレッドを作成し、スレッド UUID を返します。

リクエスト¶

リクエストヘッダー¶

ヘッダー	説明
`Authorization`	（必須）認証トークン詳細については、認証をご参照ください。
`Content-Type`	（必須）application/json

リクエスト本文¶

リクエスト本文には、以下のフィールドを含めることができます。

フィールド	型	説明
`origin_application`	string	（オプション）スレッドを作成したアプリケーションの名前。アプリケーションごとにスレッドをグループ化できます。16バイトに制限されています。

例:

{
  "origin_application": "my_app"
}

Copy

応答¶

スレッド UUID を文字列として返します。

"1234567890"

Copy

スレッドを記述する¶

GET /api/v2/cortex/threads/{id}

スレッドを記述し、page_sizeとlast_message_idに基づき、作成の降順で、そのスレッドのメッセージのバッチを返します。このリクエストは、スレッド ID がユーザーに属している場合のみ成功します。

リクエスト¶

パスパラメーター¶

パラメーター	型	説明
`id`	整数	（必須）スレッドの UUID。

クエリパラメーター¶

パラメーター	型	説明
`page_size`	整数	（オプション）返すメッセージ数（デフォルト:20、最大:100）。
`last_message_id`	整数	（オプション）受信した最後のメッセージの ID。次のバッチのオフセットを設定するために使用します。メッセージの最初のバッチについては空にできます。

リクエストヘッダー¶

ヘッダー	説明
`Authorization`	（必須）認証トークン
`Content-Type`	（必須）application/json

応答¶

スレッドメタデータオブジェクトとメッセージの配列を返します。

フィールド	型	説明
metadata	object	名前、スレッドを作成したアプリケーション、作成された時間などの、スレッドのメタデータ。
`messages`	array	メッセージオブジェクトの配列。

metadata¶

フィールド	型	説明
`thread_id`	整数	スレッドの UUID。
`thread_name`	string	スレッドの名前。
`origin_application`	string	スレッドを作成したアプリケーションの名前。
`created_on`	整数	スレッドが作成された時刻（UNIX エポックからのミリ秒）。
`updated_on`	整数	スレッドが最後に更新された時刻（UNIX エポックからのミリ秒）。更新には、スレッドに新しいメッセージを追加することが含まれます。

メッセージ¶

フィールド	型	説明
`message_id`	整数	メッセージの UUID。
`parent_id`	整数	親メッセージの UUID。
`created_on`	整数	メッセージが作成された時刻（UNIX エポックからのミリ秒）。
`role`	string	このメッセージを生成したロール。
`message_payload`	string	メッセージペイロード。
`request_id`	string	元のメッセージのリクエスト ID。

例:

{
  "metadata": {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  },
  "messages": [
    {
      "message_id": 1,
      "parent_id": null,
      "created_on": 1717000000000,
      "role": "user",
      "message_payload": "Hello, I need help.",
      "request_id": "req_001"
    },
    {
      "message_id": 2,
      "parent_id": 1,
      "created_on": 1717000001000,
      "role": "assistant",
      "message_payload": "How can I assist you?",
      "request_id": "req_002"
    }
  ]
}

Copy

スレッドを更新する¶

POST /api/v2/cortex/threads/{id}

スレッドを更新します。

リクエスト¶

パスパラメーター¶

パラメーター	型	説明
`id`	整数	（必須）スレッドの UUID。

リクエストヘッダー¶

ヘッダー	説明
`Authorization`	（必須）認証トークン
`Content-Type`	（必須）application/json

リクエスト本文¶

フィールド	型	説明
`thread_name`	string	（オプション）スレッドの名前。

例:

{
  "thread_name": "New Thread Name"
}

Copy

応答¶

スレッドの更新のステータスを返します。

{"status": "Thread xxxx successfully updated."}

Copy

スレッドをリストする¶

GET /api/v2/cortex/threads

ユーザーに属するすべてのスレッドをリストします。

リクエスト¶

クエリパラメーター¶

パラメーター	型	説明
`origin_application`	string	（オプション）この基点のアプリケーションによってスレッドのリストをフィルタリングします。このフィールドを指定しないと、すべてのスレッドが返されます。

リクエストヘッダー¶

ヘッダー	説明
`Authorization`	（必須）認証トークン
`Content-Type`	（必須）application/json

応答¶

スレッドメタデータオブジェクトの配列を返します。

スレッドメタデータ¶

フィールド	型	説明
`thread_id`	整数	スレッドの UUID。
`thread_name`	string	スレッドの名前。
`origin_application`	string	スレッドを作成したアプリケーションの名前。
`created_on`	整数	スレッドが作成された時刻（UNIX エポックからのミリ秒）。
`updated_on`	整数	スレッドが最後に更新された時刻（UNIX エポックからのミリ秒）。更新には、スレッドに新しいメッセージを追加することが含まれます。

例:

[
  {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  }
]

Copy

スレッドを削除する¶

DELETE /api/v2/cortex/threads/{id}

スレッドとそのスレッド内のすべてのメッセージを削除します。

リクエスト¶

パスパラメーター¶

パラメーター	型	説明
`id`	整数	（必須）スレッドの UUID。

リクエストヘッダー¶

ヘッダー	説明
`Authorization`	（必須）認証トークン
`Content-Type`	（必須）application/json

応答¶

スレッドが削除された場合は、成功の応答を返します。

{
  "success": true
}

Copy