ファイル削除リクエストの作成
単一または一括の非同期ファイル削除を依頼
中国本土のユーザー向け: 中国本土のユーザーは https://api.toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://api.toapis.com を https://api.toapis.cn に置き換えてください.
動作
指定した 1 ファイルまたは現在のアカウントの既存ファイル全体の削除を依頼します. 削除は非同期で, HTTP 202 は受理を示します. 返された id で進捗を確認します.
- 1 ファイルの削除:
{"scope":"single","file_id":"123"}を送信します. ID はファイル一覧から取得します. - 既存ファイルの全削除:
{"scope":"all"}を送り,file_idは省略します. リクエスト後に作成されたファイルは対象外です.
all はこのリクエスト以前に作成された自身の登録済みファイルが対象です. 古いファイルの遅延登録も含まれ得ます. 境界時刻はサーバーが決めます. 手動削除は自動削除スイッチに依存しません. POST ごとに新しい依頼を作成するため, タイムアウト後に無条件で再送しないでください. 取消操作はありません.
クエリパラメータは不可です. 本文は最大 4096 バイトの JSON オブジェクトで, 未知または重複フィールドを拒否します. 本文読み取り期限は 10 秒です. 公開アカウントの書き込み上限はユーザーごと毎分 10 回を共有します. サービスが一時的に利用できない場合は 503 です.
認証
Authorizationstringヘッダー必須システムアクセストークンを Bearer YOUR_SYSTEM_ACCESS_TOKEN で送信します. モデル API キーは利用できず, X-User-Id は不要です. 認証アカウント自身のファイルと設定のみが対象で, サブアカウントは集約しません.
リクエストパラメータ
scopestringボディ必須必須. 削除範囲を選択します:
single: 指定した 1 ファイルを削除.file_idが必須です.all: 現在のアカウントの既存登録ファイルを全削除.file_idは省略し, リクエスト後の新規ファイルは対象外です.
file_idstring | nullボディ削除するファイル ID. ファイル一覧の data.items[].id から取得します. 例: "123". scope=single では有効な ID 文字列が必須です. scope=all では省略するか null を送信します. null は省略と同じ扱いです.
リクエスト例
curl --request POST \
--url 'https://api.toapis.com/api/v1/user/file/deletion-requests' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{"scope":"single","file_id":"123"}'import requests
response = requests.post(
"https://api.toapis.com/api/v1/user/file/deletion-requests",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
json={"scope": "single", "file_id": "123"},
timeout=30,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.toapis.com/api/v1/user/file/deletion-requests", {
method: "POST",
headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN", "Content-Type": "application/json" },
body: JSON.stringify({"scope": "single", "file_id": "123"}),
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());今回の受理時刻以前に作成されたファイルを削除:
curl --request POST \
--url 'https://api.toapis.com/api/v1/user/file/deletion-requests' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{"scope":"all"}'レスポンスフィールド
例は架空のデータです. 共通のレスポンス形式は利用方法を参照してください.
data.idstring進捗照会用の削除リクエスト ID.
data.scopestringsingle は指定 1 ファイルの削除, all は現在のアカウントの既存ファイルの全削除です.
data.file_idstring | null単一削除ではファイル ID, 一括では null.
data.created_before_atstring | null一括削除の作成日時の上限. その時刻を含み, 単一削除は null.
data.statestringpending: 受理; running: 実行中; processed: 現在範囲の完了; blocked: 対象ファイルの停止または進捗更新の失敗.
data.discovered_countinteger現在発見済みの対象数. 遅延登録で増える場合があります.
data.deleted_countinteger削除済みの累計. 一覧からファイルが消えた後も保持します.
data.blocked_countinteger停止中のファイル数. 進捗更新自体が失敗した場合も blocked となり, 件数は前回成功値を保持します.
data.created_atstringリクエスト作成日時.
data.updated_atstring進捗の最終更新日時.
レスポンス例
{
"code": 0,
"message": "",
"data": {
"id": "456",
"scope": "single",
"file_id": "123",
"created_before_at": null,
"state": "pending",
"discovered_count": 0,
"deleted_count": 0,
"blocked_count": 0,
"created_at": "2026-11-16T08:00:00Z",
"updated_at": "2026-11-16T08:00:00Z"
}
}エラー
scope, file_id, JSON, クエリパラメータが不正な場合は 400 です. 対象ファイルが存在しないか他人の所有なら 404, 書き込みまたは書き込み枠が利用できない場合は 503 (code=13035) です.
共通の認証, レート制限, エラー処理は利用方法を参照してください.