Usage

For overseas integrations, the stable account check today is Profile. Use it to read credits, tier, and remaining API quota before large operations. Dedicated usage endpoints should be treated as schema-driven: call only paths present in GET /api/openapi.json.

Request

Profile uses a normal bearer-authenticated request:

GET /api/open/v1/profile
Authorization: Bearer YOUR_API_TOKEN

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response

{
  "user_id": "user_123",
  "api_quota_remaining": 988000,
  "tier": "pro",
  "credits": 1200
}

Use the response for operational guardrails, not as a reservation. Other workers may consume balance after you check it.

Billing And Credits

Store balance snapshots around expensive batches. If customers ask why a batch stopped, compare the starting profile snapshot, completed job count, failed job count, and final profile snapshot.

Errors

Profile errors follow the shared API error shape. If a future usage endpoint appears in the schema, apply the same retry and logging rules: log requestId, avoid logging tokens, and pause batch creation on insufficient credits.