セッションの一覧取得

GET /api/v1/forward/sessions 認証されたアカウント配下のセッションを一覧取得します。デフォルトでは作成日時の降順で並び、アーカイブ済みのセッションは返されません。

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT または SAT>`

Query parameters

Parameter	Type	Required	Default	Description
`search`	string	No	-	検索キーワード。値が `sess_` で始まる場合は最初に Session ID の完全一致を試し、それ以外はタイトルを検索します。照合ルールは Notes を参照してください。
`identity_ids`	string or array	No	-	1 つ以上の Identity ID でフィルターします。カンマ区切りの文字列に対応。
`template_id`	string	No	-	Forward Template ID でフィルターします。
`source_type`	string	No	-	`api`、`im`、`schedule`、または `batch` でフィルターします。
`created_at[gt]`	string	No	-	この RFC 3339 タイムスタンプより後に作成。
`created_at[gte]`	string	No	-	この RFC 3339 タイムスタンプ以降に作成。
`created_at[lt]`	string	No	-	この RFC 3339 タイムスタンプより前に作成。
`created_at[lte]`	string	No	-	この RFC 3339 タイムスタンプ以前に作成。
`updated_at[gt]`	string	No	-	この RFC 3339 タイムスタンプより後に更新。
`updated_at[gte]`	string	No	-	この RFC 3339 タイムスタンプ以降に更新。
`updated_at[lt]`	string	No	-	この RFC 3339 タイムスタンプより前に更新。
`updated_at[lte]`	string	No	-	この RFC 3339 タイムスタンプ以前に更新。
`limit`	integer	No	20	1 ページあたりの件数。最大 100。
`after_id`	string	No	-	次ページ用カーソル。前ページのレスポンスの `last_id` を指定します。
`before_id`	string	No	-	前ページ用カーソル。現在のページのレスポンスの `first_id` を指定します。
`order`	string	No	`desc`	作成日時のソート順: `desc` または `asc`。
`include_archived`	boolean	No	`false`	アーカイブ済みのセッションを含めます。

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

タイトルのキーワードで検索：

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions?search=support' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Session ID で完全一致検索：

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions?search=sess_xxx' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

次のページを取得：

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions?limit=20&order=desc&after_id=sess_xxx' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK

{
  "data": [
    {
      "id": "sess_xxx",
      "type": "session",
      "identity_id": "idn_xxx",
      "template": {
        "id": "tmpl_support",
        "type": "template",
        "name": "Support assistant",
        "model": "ultimate",
        "version": 3
      },
      "source_type": "im",
      "status": "idle",
      "title": "Customer support session",
      "metadata": {
        "source": "dingtalk"
      },
      "config": {
        "environment_variables": {
          "API_KEY": "sk-xxx"
        }
      },
      "resources": [
        {
          "id": "sesr_xxx",
          "type": "file",
          "file_id": "file_xxx",
          "mount_path": "/data/workspace/spec.md",
          "created_at": "2026-06-23T05:53:19Z",
          "updated_at": "2026-06-23T05:53:38Z"
        }
      ],
      "stats": {
        "active_seconds": 30,
        "duration_seconds": 3600
      },
      "usage": {
        "total_credits": 12.5
      },
      "outcome_evaluations": [],
      "archived_at": null,
      "created_at": "2026-06-22T10:00:00Z",
      "updated_at": "2026-06-22T11:00:00Z"
    }
  ],
  "first_id": "sess_xxx",
  "last_id": "sess_xxx",
  "has_more": false
}

Response fields

Field	Type	Description
`data`	array	現在のページの Session オブジェクト。
`first_id`	string\|null	このページの最初のレコードの ID。
`last_id`	string\|null	このページの最後のレコードの ID。
`has_more`	boolean	さらにレコードが残っているかどうか。

Errors

HTTP	Type	Code	Trigger
400	`invalid_request_error`	`invalid_time_range`	時間フィルターが無効。
400	`invalid_request_error`	`invalid_time_filter`	時間フィルターの形式が無効。
400	`invalid_request_error`	`invalid_pagination`	ページネーションパラメーターが無効。
400	`invalid_request_error`	`invalid_limit`	`limit` が無効、または最大値を超えている。
400	`invalid_request_error`	`invalid_order`	`order` が `asc` または `desc` ではない。
400	`invalid_request_error`	`invalid_search`	`search` が有効な UTF-8 ではない、512 バイトを超える、または制御文字を含む。
401	`authentication_error`	`authentication_required`	PAT または SAT が無効または期限切れ。

Notes

search の一致ルール：

値が sess_ で始まる場合、API は最初に Session ID の完全一致を試します。見つかった場合はその Session のみを返し、見つからない場合はタイトル検索にフォールバックします。
タイトル検索は大文字と小文字を区別しない部分一致です。%、_、\ はリテラル文字として扱われます。
先頭と末尾の空白は削除されます。残りの値は有効な UTF-8 で、512 バイト以下、かつ制御文字を含まない必要があります。

その他の注意事項：

after_id と before_id は併用できません。
一覧は created_at でソートされます。作成日時が同じ場合は Session ID を同じ方向でソートし、安定したページネーションを保証します。
ページを続けて取得する場合は、同じフィルター条件と order を維持してください。
現在の設計では status によるフィルタリングはサポートしていません。
usage 内の各フィールドはそれぞれ任意です。過去の Session では一部のフィールドが含まれない場合があり、明示的なゼロ値は保持されます。
resources は Session にマウントされたリソースです。現在はSession リソースを追加で追加した file のみを含み、ない場合は空配列です。

セッションの一覧取得

Headers

Query parameters

Example request

Example response

Response fields

Errors

Notes

セッションの作成

セッションの取得

​Headers

​Query parameters

​Example request

​Example response

​Response fields

​Errors

​Notes

​Related

セッションの作成

セッションの取得

Headers

Query parameters

Example request

Example response

Response fields

Errors

Notes

Related