ToAPIsToAPIs
Файлы пользователя

Создать запрос удаления файлов

Асинхронное удаление одного файла или группы файлов

POST
/api/v1/user/file/deletion-requests

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Поведение

Запрашивает удаление одного файла или всех существующих файлов текущего аккаунта. Удаление асинхронное: HTTP 202 означает приём. Полученный id используйте для проверки прогресса.

  • Один файл: отправьте {"scope":"single","file_id":"123"}. ID возьмите из списка файлов.
  • Все существующие файлы: отправьте {"scope":"all"} без file_id. Файлы, созданные после запроса, не затрагиваются.

all охватывает собственные зарегистрированные файлы, созданные до этого запроса. Старые файлы с поздней регистрацией тоже могут войти в область. Границу определяет сервер. Ручное удаление не зависит от автоочистки. Каждый POST создаёт новый запрос, поэтому не повторяйте его вслепую после тайм-аута. Отмена не предусмотрена.

Параметры строки запроса не принимаются. Тело должно быть JSON-объектом не более 4096 байт; неизвестные и повторные поля отклоняются. Срок чтения тела: 10 секунд. Запись публичного аккаунта делит лимит 10 запросов в минуту на пользователя. Временная недоступность сервиса возвращает 503.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте системный токен доступа: Bearer YOUR_SYSTEM_ACCESS_TOKEN. Ключи моделей не принимаются, X-User-Id не нужен. Доступны только файлы и настройки текущего аккаунта, без объединения данных субаккаунтов.

Параметры запроса

scopestringтелообязательно

Обязательно. Выберите область удаления:

  • single: один указанный файл, обязателен 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.scopestring

single удаляет один файл, all удаляет все существующие файлы текущего аккаунта.

data.file_idstring | null

ID файла для одиночного удаления, иначе null.

data.created_before_atstring | null

Включительная граница времени создания для массового удаления, иначе null.

data.statestring

pending: принят; 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).

Общие правила авторизации, лимитов и ошибок см. в разделе Подключение.