Saltar al contenido

API · Referencia

Cuenta y saldo

GET /v1/account — el saldo disponible de la cuenta en créditos, además del número de solicitudes y los créditos gastados por esta clave en los últimos 30 días.

Obtenga el saldo disponible de la cuenta en créditos y las estadísticas de uso de la clave.

Playground

GET
/v1/account

Authorization

Authorization<token>

API-ключ в заголовке Authorization со схемой Bearer:

Authorization: Bearer <CLIPIA_API_KEY>

Передавайте полную строку, включая префикс схемы Bearer и пробел. Также принимаются Authorization: Key <ключ> и заголовок X-Api-Key: <ключ> — выбирайте удобную схему. Ключ создаётся в консоли разработчика (clipia.ai/developer, вкладка «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": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Retry after the reset window.",
    "retry_after_seconds": 12
  }
}

GET /v1/account devuelve el saldo de la cuenta a la que pertenece la clave y un resumen de esta clave en los últimos 30 días. Sirve cualquier clave válida: no se necesita ningún permiso adicional.

GET/v1/account

Solicitud

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"])

Respuesta 200

{
  "account_id": "8f3a1c7e-2b4d-4e6f-9a01-23456789abcd",
  "balance": { "credits": 1840 },
  "usage_30d": { "requests": 512, "credits_spent": 6120 }
}

Prop

Type

Créditos

Las generaciones y el chat con LLM descuentan créditos del saldo de la cuenta a la que pertenece la clave. Puede recargar el saldo en clipia.ai. Si no hay créditos suficientes, submit devuelve 402 insufficient_credits.

Estimación del coste

POST /v1/models/{model}/estimate — averigüe cuánto cuesta una generación en créditos antes de ejecutarla; no se crea ningún trabajo ni se reservan créditos.

Idempotencia

La cabecera Idempotency-Key hace que reintentar el envío de una generación sea seguro — la misma solicitud devuelve el mismo request_id sin un segundo trabajo ni un segundo cargo.