GET /v1/sessions
現在のアカウント配下の Session 一覧を取得します。カーソルページネーションをサポートします。アーカイブ済み Session はデフォルトで除外されます。結果はデフォルトで Session ID の降順でソートされ、生成される ID では新しい順に相当します。
ヘッダー
| 名称 | 必須 | 値 |
|---|---|---|
| Authorization | はい | Bearer $QODER_PAT |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | 返却件数の上限、デフォルト 20 |
after_id | string | いいえ | カーソルページネーション:この ID 以降のレコードを返す |
before_id | string | いいえ | カーソルページネーション:この ID 以前のレコードを返す |
order | string | いいえ | ソート方向:desc(デフォルト)または asc |
include_archived | boolean | いいえ | true を設定するとアーカイブ済み Session を含む |
statuses[] | string | いいえ | 1 つ以上の Session ライフサイクル状態でフィルタリング。複数値の場合はパラメータを繰り返します。 |
agent_id | string | いいえ | Agent ID で Session をフィルタリング |
agent_version | integer | いいえ | Agent バージョンで Session をフィルタリング。0 または省略時はフィルタリングしません。 |
environment_id | string | いいえ | Environment ID で Session をフィルタリング |
created_at[gt] | string | いいえ | この RFC 3339 タイムスタンプより後に作成されたレコードを返す |
created_at[gte] | string | いいえ | この RFC 3339 タイムスタンプ以降に作成されたレコードを返す |
created_at[lt] | string | いいえ | この RFC 3339 タイムスタンプより前に作成されたレコードを返す |
created_at[lte] | string | いいえ | この RFC 3339 タイムスタンプ以前に作成されたレコードを返す |
リクエスト例
レスポンス例
HTTP 200 OKページネーションフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | array | Session オブジェクトの配列 |
first_id | string | 現在ページ先頭レコードの ID |
last_id | string | 現在ページ末尾レコードの ID |
has_more | boolean | さらにレコードがあるかどうか |
last_id を次回リクエストの after_id パラメータとして使用すると、後方ページネーションを実現できます。
エラーレスポンス
| HTTP | type | 説明 |
|---|---|---|
| 401 | authentication_error | PAT が無効または期限切れ |
関連項目
Session の起動
Agent を環境で実行し、ステートフルな対話を行う。