ai

GET /v1/ai/credits

Zinn® credit balance, whether to offer more, and the packs for sale.

ਸਾਰੇ ai ਐਂਡਪੁਆਇੰਟ

ਪ੍ਰਮਾਣੀਕਰਨ

API ਕੁੰਜੀ ਨੂੰ ਇੱਕ ਬੇਅਰਰ ਟੋਕਨ (bearer token) ਵਜੋਂ ਭੇਜੋ। ਕੁੰਜੀ ਵਿੱਚ sites.view ਇਜਾਜ਼ਤ ਹੋਣੀ ਲਾਜ਼ਮੀ ਹੈ; ਇਸ ਤੋਂ ਬਿਨਾਂ ਕੁੰਜੀ ਨੂੰ 404 ਦੀ ਨਹੀਂ, ਸਗੋਂ 403 ਨਾਲ ਅਸਵੀਕਾਰ ਕੀਤਾ ਜਾਂਦਾ ਹੈ।

ਜਿੱਥੇ ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਆਉਂਦੀ ਹੈ

ਇਹ ਐਂਡਪੁਆਇੰਟ org_id ਨੂੰ ਇੱਕ ਕੌਂਸਲ ਪੈਰਾਮੀਟਰ ਵਜੋਂ ਲੈਂਦਾ ਹੈ। ਇਸਨੂੰ ਛੱਡ ਦਿਓ ਅਤੇ ਕਾਲ ਤੁਹਾਡੇ ਪੂਰੇ ਟੈਨੈਂਸੀ ਸਬਟ੍ਰੀ ਨੂੰ ਕਵਰ ਕਰੇਗੀ; ਕਾਲ ਨੂੰ ਇੱਕ ਸੰਸਥਾ ਤੱਕ ਸੀਮਤ ਕਰਨ ਲਈ ਇਸਨੂੰ ਭੇਜੋ।

ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ 'ਤੇ API ਕੁੰਜੀਆਂ ਵਾਲੀ ਸਕ੍ਰੀਨ 'ਤੇ, ਕੁੰਜੀ ਦੇ ਬਿਲਕੁਲ ਨਾਲ ਮੌਜੂਦ ਹੈ। ਇਹ ਤੁਹਾਡੇ ਵੱਲੋਂ ਕੀਤੀ ਜਾਣ ਵਾਲੀ ਹਰ ਕਾਲ ਵਿੱਚ ਉਹੀ ਆਈਡੀ ਹੁੰਦੀ ਹੈ।

ਕੋਸ਼ਿਸ਼ ਕਰੋ

ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।

curl -X GET https://api.zinndigital.com/v1/ai/credits \
  -H "Authorization: Bearer zdk_live_…"

ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation id) ਅਤੇ ਤੁਹਾਡੀ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਭਰਦਾ ਹੈ, ਅਤੇ ਲਾਈਵ API ਦੇ ਵਿਰੁੱਧ ਬੇਨਤੀ ਚਲਾਉਂਦਾ ਹੈ ਤਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਜਵਾਬ ਦੇਖ ਸਕੋ। API ਕੰਸੋਲ ਵਿੱਚ ਇਸ ਐਂਡਪੁਆਇੰਟ ਨੂੰ ਖੋਲ੍ਹੋ

ਵੇਰਵੇ

Everything the three credit surfaces need, in **one** request: the balance, whether this customer is genuinely short, and the packs they can buy. The AI page, the header chip and the upsell banner all read this endpoint rather than each deciding "is this customer low?" for itself. Two behaviours reading one fact is how a header comes to nag somebody the banner has decided is fine, so `state.is_low` is computed server-side and every surface renders it. `state.on_byo` is `true` only when a live customer key exists for **every** provider we route to, so credits genuinely cannot be spent. The banner must stay silent in that case: selling credit to somebody whose every call runs on their own key sells them something that will never be spent. It is **not** "this org has a key" — a customer holding one Anthropic key still pays us for Google, OpenAI and xAI. Amounts are USD **micros** (1 minor unit = 10,000 micros; 1 USD = 1,000,000), because one model call costs a fraction of a cent and rounding each one up to a penny over-bills by two orders of magnitude. `packs[].price_minor` is ordinary integer minor units, because that is what the customer is charged. Requires `sites.view`.

ਪੈਰਾਮੀਟਰ

ਨਾਮਕਿਸਮਲਾਜ਼ਮੀਕੀ ਹੈ ਇਹ
org_id (query)UuidਨਹੀਂWhich organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

ਜਵਾਬ

ਨਾਮਕਿਸਮਲਾਜ਼ਮੀਕੀ ਹੈ ਇਹ
stateAiCreditStateਹਾਂ
packsAiCreditPack[]ਹਾਂ
settingsAiCreditSettingsਹਾਂThe customer's standing instruction about topping up, and what has become of it. Owner, 2026-08-24, reading `/ai` on production: *"The auto top section doesnt allow you to selec…
historyAiCreditHistoryLine[]ਹਾਂThe 25 most recent movements, newest first.
funding_routesAiProviderFunding[]ਹਾਂWho pays for the next call, per provider. Read on the SAME request as the balance, so a screen cannot render a funding claim from one moment beside a balance from another.
spendsAiCreditSpend[]ਹਾਂEverything this credit buys — the metered surfaces derived from the engine's own meter, the credit-only spends that write no usage row, and the fixed-price AI products.

ਇਹ ਐਂਡਪੁਆਇੰਟ ਜੋ ਗਲਤੀਆਂ ਵਾਪਸ ਕਰ ਸਕਦਾ ਹੈ

401 · 403 · 422 · 429