ToAPIsToAPIs
ユーザーファイル

ユーザーファイル一覧

現在のアカウントの登録済みファイルをページ単位で取得

GET
/api/v1/user/file

中国本土のユーザー向け: 中国本土のユーザーは https://api.toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://api.toapis.com を https://api.toapis.cn に置き換えてください.

動作

自身の登録済みファイルを作成日時の降順, 同時刻は ID の降順で返します. 未登録の過去のストレージオブジェクトは対象外です. ダウンロード URL, 保存パス, プロンプトは返しません. タスクの関連付けは後から補完される場合があります.

data.items, data.next_cursor のみを返し, has_more, meta, 総件数はありません. 空でない next_cursor をそのまま次の cursor に渡します. 最終ページは "", 空の一覧は [] です. カーソルはアカウントに紐付き, 改ざんや別アカウントでの使用は 400 です. limit と cursor のみ対応し, 時間や削除状態の絞り込みはできません.

認証

Authorizationstringヘッダー必須

システムアクセストークンを Bearer YOUR_SYSTEM_ACCESS_TOKEN で送信します. モデル API キーは利用できず, X-User-Id は不要です. 認証アカウント自身のファイルと設定のみが対象で, サブアカウントは集約しません.

リクエストパラメータ

limitintegerクエリデフォルト: 50

1 ページの件数. 既定 50, 範囲 1-100.

cursorstringクエリ

前ページの空でない next_cursor. 初回は省略し, 空文字列になったら終了します.

リクエスト例

curl --request GET \
  --url 'https://api.toapis.com/api/v1/user/file?limit=50' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'
import requests

response = requests.get(
    "https://api.toapis.com/api/v1/user/file?limit=50",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.toapis.com/api/v1/user/file?limit=50", {
  method: "GET",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

レスポンスフィールド

例は架空のデータです. 共通のレスポンス形式は利用方法を参照してください.

data.itemsobject[]

今回のファイル一覧. 空は [].

data.items[].idstring

単一ファイル削除用の ID.

data.items[].sourcestring

登録元. 例: task_result, upload, private_asset.

data.items[].task_kindstring | null

任意の関連タスク種別. 例: generation, export.

data.items[].task_idstring | null

関連タスク ID. 未関連付けは null.

data.items[].mime_typestring | null

MIME 型. 不明は null.

data.items[].size_bytesinteger | null

バイト単位のサイズ. 不明は null.

data.items[].created_atstring

ファイル作成日時. 登録日時ではありません.

data.items[].delete_statestring

none: 削除キュー未登録; pending: 待機; deleting: 実行中; blocked: 停止; deleted: 過去の行のみ. 一覧は完全な削除履歴を保持しません.

data.next_cursorstring

次ページのカーソル. 最終ページは空文字列.

レスポンス例

{
  "code": 0,
  "message": "",
  "data": {
    "items": [
      {
        "id": "123",
        "source": "task_result",
        "task_kind": "generation",
        "task_id": "task_example_01",
        "mime_type": "image/png",
        "size_bytes": 204800,
        "created_at": "2026-11-01T08:00:00Z",
        "delete_state": "none"
      }
    ],
    "next_cursor": ""
  }
}

エラー

limit, cursor, クエリパラメータが不正な場合は 400, ファイルの読み取りが一時的に利用できない場合は 503 です.

共通の認証, レート制限, エラー処理は利用方法を参照してください.