hosting

GET /v1/sites/{siteId}/ide-assist/credit

What the site's web editor shows beside its assistant.

ټول hosting پای ټکي

ټول د پراختیا کونکي اسناد

تصدیق‌هویت

دا پای ټکی عامه دی. دا هېڅ اعتبار او هېڅ سازمان ته اړتیا نه لري - دا هغه څه دي چې زموږ خپله د بازار موندنې پاڼه او د مصنوعي ځيرکتیا د ځواب انجنونه یې لولي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ide-assist/credit

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

The AI balance for the organisation that owns this site, and where its owner tops it up. The editor paints this when the assistant panel opens; every chat turn carries the same object back afterwards, so the number the customer sees is the one after their own question rather than one call behind it. spendable_micros is the figure to render, not balance_micros. They differ by whatever is left of today's included allowance, and an organisation with a zero balance and an unspent allowance can still ask the assistant anything it likes. This never refuses for lack of credit: the customer who has run out is precisely the one who needs this screen and its top_up_url.

پارامترونه

نومډولاړیندا څه شی دی
siteId (path)UuidهوSite ID (UUIDv7).

ځواب

نومډولاړیندا څه شی دی
availablebooleanهوFalse when the meter could not be read. A third state on purpose: we could not look is not you have nothing, and collapsing them puts a top-up prompt in front of an account…
currencystringنهISO 4217, for the amounts below.
balance_microsintegerنهPurchased credit held, in USD micros. ⛔ Not what they can spend — see spendable_micros.
spendable_microsintegerنهEverything that can pay for the next call: the balance PLUS what is left of today's included allowance. This is the number the editor renders.
included_remaining_microsintegerنهWhat is left of today's included allowance, in USD micros.
is_lowbooleanنهWhether what is spendable is low enough to say so. Computed by the meter rather than by each screen, because a second implementation of "low" is a second answer and the screen's…
is_emptybooleanنهNothing can fund the next call — no credit and no allowance left.
on_byobooleanنهThe organisation holds a live key for every provider we route to, so credit genuinely cannot be spent. The editor shows no top-up affordance here: selling credit to somebody whose…
top_up_urlstringنهWhere this customer adds credit, resolved from their own brand — a reseller's customer is never sent to a hostname that is not their reseller's. Empty when on_byo is true,…

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

404