ToAPIsToAPIs
User files

Get file retention

Read the current account's saved retention in days

GET
/api/v1/user/file/retention

Note for users in mainland China: Please use https://api.toapis.cn as the API endpoint (Base URL). Replace https://api.toapis.com with https://api.toapis.cn in the examples in this document.

Behavior

Read the current account's custom file retention in days. null means no custom setting, so platform retention rules apply. The platform default is 30 days.

A user setting can shorten retention but cannot extend platform deadlines. See Set file retention for setting and clearing examples.

Authentication

Authorizationstringheaderrequired

Use a system access token: Bearer YOUR_SYSTEM_ACCESS_TOKEN. Model API keys are not accepted and X-User-Id is not needed. Access is limited to the authenticated account's files and policy, without subaccount aggregation.

Request parameters

No query parameters or request body. Unknown or repeated query parameters return 400.

requestExample

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

response = requests.get(
    "https://api.toapis.com/api/v1/user/file/retention",
    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/retention", {
  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());

Response fields

Examples use fictional data. See Access for the shared response format.

data.retention_daysinteger | null

User-defined retention in days. null means no custom setting; platform rules apply, with a default of 30 days.

responseExample

{
  "code": 0,
  "message": "",
  "data": {
    "retention_days": null
  }
}

Errors

Unknown or repeated query parameters return 400. Temporarily unavailable policy reads return 503.

See Access for shared authentication, rate limits, and error handling.