Browse the API docs
Endpoint reference

Account

The Crayo Account API returns the account behind an API key: its plan, credit balances by type, storage usage and rate limits. Call GET /v1/account before a batch run to confirm you have the credits and storage the run needs.

Get account

GET/v1/account

Returns the account behind the API key: plan, credit balances by type, storage usage, and the rate limits that apply to your key. Call it before a batch run to confirm you have the credits and storage the run needs.

Credits:
Free
Rate limit:
Default tier, 2/s and 50/min

Request

curl
curl "https://api.crayo.ai/v1/account" \
  -H "Authorization: Bearer $CRAYO_API_KEY"

Response

200 application/json
{
  "success": true,
  "account": {
    "id": "cm7x0v8qa0000abcd",
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "plan": "Creator"
  },
  "credits": {
    "export": 4210,
    "voiceover": 9800,
    "image": 320,
    "video": 45,
    "tracker": 1840
  },
  "storage": {
    "used_bytes": 5312000,
    "trashed_bytes": 0,
    "allowed_bytes": 107374182400
  },
  "rate_limit": {
    "default": {
      "requests_per_second": 2,
      "requests_per_minute": 50
    },
    "heavy": {
      "requests_per_second": 2,
      "requests_per_minute": 10
    },
    "polling": {
      "requests_per_second": 2,
      "requests_per_minute": 120
    },
    "uploads": {
      "requests_per_second": 2,
      "requests_per_minute": 20
    },
    "view_tracker": {
      "raw": {
        "requests_per_second": 5,
        "requests_per_minute": 200
      },
      "read": {
        "requests_per_second": 5,
        "requests_per_minute": 300
      },
      "write": {
        "requests_per_second": 2,
        "requests_per_minute": 60
      },
      "batch": {
        "requests_per_second": 1,
        "requests_per_minute": 10
      }
    }
  }
}

Errors

  • 401MISSING_API_KEYNo Authorization header was sent, or it does not carry a crayo_sk_ key.
  • 401UNAUTHORIZEDThe key sent is malformed, expired, or revoked.
  • 429RATE_LIMITEDOver the rate limit. Wait Retry-After seconds.
  • 500SERVER_ERRORSomething failed on our side. Retry with backoff.
New to the Crayo API? See what it is forUse cases, pricing and the console walkthrough live on the API feature page.

FAQs

Frequent questions

No. It is free and sits in the default rate tier of 2 requests per second and 50 per minute.

The credits object carries one balance per credit type: image, voiceover, export, video, tracker. They are the same balances the Crayo app spends.

Read storage.used_bytes, storage.trashed_bytes and storage.allowed_bytes. Uploads, imports and generated media all count toward allowed_bytes until you delete them.

Yes. The rate_limit object lists requests per second and per minute for the default, heavy, polling and uploads tiers, plus the raw, read, write and batch tiers used by View Tracker.

Still have questions?

Contact our 24/7 support team for any concerns or inquiries.

Get in touch