GET /v1/files
現在のアカウント配下のファイルを取得します。デフォルトでは deleted ステータスのファイルは除外されます。
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer $QODER_PAT |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | 1 ページあたりの最大件数。正の整数である必要があり、デフォルト 20、最大 100 |
after_id | string | いいえ | カーソルページネーション:この file_id 以降のファイルを返す。before_id と排他 |
before_id | string | いいえ | カーソルページネーション:この file_id 以前のファイルを返す。after_id と排他 |
order | string | いいえ | created_at と id によるソート方向。asc または desc、デフォルトは desc |
purpose | string | いいえ | ファイル用途でフィルタ。ファイル用途を参照 |
name | string | いいえ | ファイル名の前方一致検索(大文字小文字を区別しない) |
session_id | string | いいえ | Session に関連付けられたファイルでフィルタ。status を省略した場合、Session スコープのリストは ready ファイルのみを返します |
status | string | いいえ | ファイルステータスでフィルタ。設定するとデフォルトの deleted 除外を上書きします |
include_deleted | boolean | いいえ | status を省略した場合、true を設定すると deleted ステータスのファイルを含みます |
リクエスト例
レスポンス例
HTTP 200 OKレスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | array | ファイルオブジェクトの配列 |
first_id | string | null | 現在ページ先頭ファイルの ID。data が空の場合は null |
last_id | string | null | 現在ページ末尾ファイルの ID。data が空の場合は null |
has_more | boolean | さらにファイルがあるかどうか |
ページネーション
結果はcreated_at と id でソートされます。ファイルをページングするには:
- 初回リクエストで
limitを設定し、最初のページを取得 has_moreがtrueの場合、after_id=<last_id>で次のページを取得before_id=<first_id>で前方ページネーションが可能
エラーレスポンス
| HTTP | type | 説明 |
|---|---|---|
| 400 | invalid_request_error | limit が無効、または before_id と after_id の両方が指定されている |
| 401 | authentication_error | 認証トークンが欠落または無効 |
関連項目
ファイルの添付とダウンロード
Agent にコンテキストを提供するファイルをアップロードし、Agent が生成したファイルをダウンロードします。