Skip to article
Documentation

Search documentation

Search stays in this browser. Queries are not sent or saved. Do not paste credentials.

Loading the public search index…

Tab or arrow keys to navigate · Enter to open · Esc to close
Browse documentation

Get account and limits

Source-generated GET /account reference: authentication, fields, responses, errors, and operational safeguards.

Public betaAPI v1 · 1.3.0Last verified
On this page

Operation

GET /account

operationId: account_v1_account_get

Read the authenticated account, developer access tier, optional subscription period, key identity/scopes, and account-wide limits. Key secrets are never returned. Subscriptions raise limits but are not required for access. Keep the same key identity when recovering an uncertain idempotent create.

Authentication and side effects

Use a server-side Bearer API key. Required scope: animations:read

This operation does not start paid generation. Other state changes are described above.

Parameters

No path, query, or operation-specific header parameters.

Responses

HTTP Body Meaning
200 AccountResponse Successful public response. Example values are illustrative.
400 APIErrorEnvelope Invalid input; correct the request before retrying.
401 APIErrorEnvelope Missing, expired, or revoked API key.
403 APIErrorEnvelope Account eligibility, account status, or key scope does not allow this operation.
404 APIErrorEnvelope Resource is unavailable, not owned, or its signature is invalid/expired.
429 APIErrorEnvelope Account-wide rate or queue limit; wait for Retry-After.
500 APIErrorEnvelope Internal failure; preserve the task/key and retry only when marked retryable.
503 APIErrorEnvelope Service/provider unavailable; retry only when error.retryable is true.

Response headers

HTTP Header Type Meaning
429 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
503 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.

Response example

json
{
  "api_key": {
    "id": "00000000-0000-4000-8000-000000000005",
    "scopes": [
      "animations:read",
      "animations:write"
    ]
  },
  "id": "00000000-0000-4000-8000-000000000004",
  "limits": {
    "concurrency": 1,
    "create_per_minute": 3,
    "other_per_minute": 60,
    "queue": 3
  },
  "object": "account",
  "plan": {
    "cancel_at_period_end": false,
    "code": "registered",
    "current_period_end": null
  }
}

Polling and downloads · Errors and safe retries

Was this page helpful?

No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy

Need a hand? Contact support