Core

Get Account

Read your balance and account status.

GET/v1/accountTry it

Get Account

cURL

curl --request GET \
  --url https://api.spicyapi.com/v1/account \
  --header 'Authorization: Bearer $SPICYAPI_KEY'

200

JSON

{
  "email": "you@example.com",
  "balance_usd": 42.75,
  "sandbox": false,
  "limits": { "requests_per_minute": 600, "declined_prompts_per_minute": 60, "screened_requests_per_end_user_per_minute": 30, "video_jobs_in_progress": 20 }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your SpicyAPI key (sk-spicy-…). Create one in the dashboard under API Keys.

Response

200 · application/json

Successful Response

emailstringrequired

The account this key belongs to.

balance_usdnumberrequired

Remaining balance in US dollars.

limitsobjectrequired

This account's limits: requests_per_minute (600 to start, raised automatically up to 6,000 for accounts that keep reaching it, or on request), declined_prompts_per_minute, screened_requests_per_end_user_per_minute and video_jobs_in_progress (20 by default). Higher limits are available on request: contact@spicyapi.com.

character_importobject

Only on accounts that had a character import window: status (open, expired, exhausted, revoked or not_enabled), expires_at, used, limit and remaining. See POST /v1/characters/import.

Was this page helpful?

Suggest edits Raise issue

Create Image