Polyrankdocs
Strategy Lab

GET /v1/lab/credits

The caller’s Lab AI credits (1 credit = $0.01 of real model cost): what is left of this period’s allowance (spent first), purchased top-ups, the total, when the allowance resets (`period_end`; unused allowance does not roll over), what a typical question costs (`typical_turn_credits`), the reserve a question needs (25), the caller’s own daily ceiling and today’s spend, whether a question may start now (`blocked`), the plan’s model and whether it has Deep mode (the deep model for a whole conversation, about twice the credits), the two modes as the app names them (`modes`), the top-up packs with their volume bonus and the custom amount’s range.

GET
/v1/lab/credits

The caller’s Lab AI credits (1 credit = $0.01 of real model cost): what is left of this period’s allowance (spent first), purchased top-ups, the total, when the allowance resets (period_end; unused allowance does not roll over), what a typical question costs (typical_turn_credits), the reserve a question needs (25), the caller’s own daily ceiling and today’s spend, whether a question may start now (blocked), the plan’s model and whether it has Deep mode (the deep model for a whole conversation, about twice the credits), the two modes as the app names them (modes), the top-up packs with their volume bonus and the custom amount’s range.

AuthorizationBearer <token>

API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/lab/credits"
{  "allowance": -9007199254740991,  "topup": -9007199254740991,  "total": -9007199254740991,  "period_end": "string",  "resets_label": "string",  "allowance_granted": -9007199254740991,  "typical_turn_credits": -9007199254740991,  "reserve": -9007199254740991,  "daily_ceiling": -9007199254740991,  "spent_today": -9007199254740991,  "blocked": "no_plan",  "blocked_message": "string",  "plan_id": "string",  "model": "string",  "deep_mode": true,  "deep_model": "string",  "deep_mode_multiplier": 0,  "packs": [    {      "pack": -9007199254740991,      "credits": -9007199254740991,      "usd": 0,      "bonus": -9007199254740991    }  ],  "price_line": "string",  "modes": [    {      "id": "standard",      "label": "string",      "multiplier": 0,      "available": true    }  ],  "custom_topup": {    "min_usd": 0,    "max_usd": 0,    "preset_usd": 0  },  "last_mode": "standard",  "start_mode": "standard"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}
{  "error": "string",  "message": "string",  "feature": "string",  "field": "string",  "plan": "string",  "retry_after_sec": 0,  "retry_after_seconds": 0,  "reason": "string",  "running": 0,  "limit": 0,  "issues": [    null  ],  "trace_id": "string"}