Documentation menu

API · Account

Current key, workspace, plan and request quota

GET /api/v1/me

Rate limited but not metered. Use this for the monthly request quota (usage.used against usage.limit); prefer /account for credits and document limits.

Returns 200

Who the key belongs to, and the month's request quota.

  • 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
  • organization object

    The workspace the key belongs to.

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

    The workspace's plan.

    3 fields
    • id string
    • name string
    • rate_limit_per_second integer
  • usage object

    Requests this month against the plan's quota.

    6 fields
    • included integer
    • limit integer

      null when there is no cap.

    • overage integer
    • percent integer
    • period_start string
    • used integer

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.