Account & balance
GET /v1/account — balance and usage.
Get your account balance in credits and usage statistics.
Playground
API-ключ в заголовке Authorization со схемой Bearer:
Authorization: Bearer clipia_live_xxxxxxxxxxxxxxxxxxxxxxПередавайте полную строку, включая префикс схемы Bearer и пробел.
Также принимаются Authorization: Key <ключ> и заголовок
X-Api-Key: <ключ> — выбирайте удобную схему.
Ключ создаётся в личном кабинете (Настройки → API-ключи) и показывается
один раз. Формат: clipia_live_… (боевой), clipia_test_… (песочница).
Sandbox / тестовый режим. Ключ с префиксом clipia_test_… работает в
песочнице: submit не списывает кредиты и не запускает реальную
генерацию — он мгновенно возвращает status: COMPLETED с детерминированным
mock-результатом (фиксированный sample-ассет на media.clipia.ai). Поле
cost показывает расчётную стоимость, но она не списывается. Вебхуки
приходят тем же подписанным механизмом (HMAC-SHA256). Режим предназначен
для отладки интеграции до подключения боевого ключа.
In: header
Response Body
curl -X GET "https://api.clipia.ai/v1/account"{
"account_id": "8f3a1c7e-2b4d-4e6f-9a01-23456789abcd",
"balance": {
"credits": 1840
},
"usage_30d": {
"requests": 512,
"credits_spent": 6120
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_api_key",
"message": "API-ключ отсутствует, неверный или отозван."
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Превышен лимит запросов. Повторите позже."
}
}GET /v1/account returns the account's credit balance and a usage summary for the last 30 days. The endpoint is available to any valid key — no scope required.
/v1/accountRequest
curl https://api.clipia.ai/v1/account \
-H "Authorization: Bearer $CLIPIA_KEY"const account = await clipia.account.get();
console.log(account.balance.credits);account = client.account.get()
print(account["balance"]["credits"])Response 200
{
"account_id": "8f3a1c7e-2b4d-4e6f-9a01-23456789abcd",
"balance": { "credits": 1840 },
"usage_30d": { "requests": 512, "credits_spent": 6120 }
}Prop
Type
Credits
Generations draw credits from the balance of the account the key belongs to. The monetary value of one credit is not exposed via the API — top up your balance in your clipia.ai account. If the balance is too low, submit returns 402 insufficient_credits.