ToAPIsToAPIs
ユーザーファイル

ファイル保持期間の取得

現在のアカウントに保存された保持日数を取得

GET
/api/v1/user/file/retention

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

動作

現在のアカウントが設定したファイル保持日数を取得します. null は独自設定なしを示し, プラットフォームの規則を適用します. 既定の保持期間は 30 日です.

ユーザー設定で保持期間を短縮できますが, プラットフォームの期限は延長できません. 設定と解除の例は保持期間の設定を参照してください.

認証

Authorizationstringヘッダー必須

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

リクエストパラメータ

クエリパラメータと本文はありません. 未知または重複したクエリパラメータは 400 です.

リクエスト例

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());

レスポンスフィールド

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

data.retention_daysinteger | null

ユーザー設定の保持日数. null は独自設定なしで, プラットフォームの規則に従います. 既定は 30 日です.

レスポンス例

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

エラー

未知または重複したクエリパラメータは 400, 設定の読み取りが一時的に利用できない場合は 503 です.

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