Documentation menu

API · Account

Workspace, plan, credits and limits

GET /api/v1/account

Rate limited but not charged, so you can poll it. Read credits.available_micro before a big batch, and limits to size uploads: exceeding max_upload_bytes is a 413 and exceeding max_pages_per_document a 422.

Returns 200

The workspace, its plan, credit and limits.

  • credits object

    What the workspace can spend.

    1 fields
    • available_micro integer

      Credit available now, in micro-USD (25000000 is US$25).

  • key object

    The key that made the call. Only a prefix of it, never the secret.

    4 fields
    • id string
    • mode live | test
    • name string
    • prefix string
  • limits object

    What one document may be on this plan.

    4 fields
    • max_concurrent_jobs integer

      Documents processed at once; more wait in the queue.

    • max_pages_per_document integer

      More pages is a 422.

    • max_retention_seconds integer

      The longest retention_seconds allowed; 0 means no limit.

    • max_upload_bytes integer

      A bigger file is a 413.

  • organization object

    The workspace the key belongs to.

    3 fields
    • id string
    • name string
    • slug string
  • plan object

    The workspace's plan.

    2 fields
    • id string
    • name string
  • rate_limit_per_second integer

    Requests allowed per second.

Errors

  • 401

    Missing, revoked or expired key
  • 429

    Per-second burst limit for the plan exceeded; retry after Retry-After seconds

Every error has the same shape. See Errors.