hosting
GET /v1/sites/{siteId}/ide-assist/credit
What the site's web editor shows beside its assistant.
احراز هویت
این نقطه پایانی عمومی است. هیچ مدرک احراز هویت و هیچ سازمانی نمیپذیرد — این همان چیزی است که سایت بازاریابی خودمان و موتورهای پاسخدهنده هوش مصنوعی میخوانند.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ide-assist/creditوارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
available | boolean | بله | 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… |
currency | string | خیر | ISO 4217, for the amounts below. |
balance_micros | integer | خیر | Purchased credit held, in USD micros. ⛔ Not what they can spend — see spendable_micros. |
spendable_micros | integer | خیر | 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_micros | integer | خیر | What is left of today's included allowance, in USD micros. |
is_low | boolean | خیر | 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_empty | boolean | خیر | Nothing can fund the next call — no credit and no allowance left. |
on_byo | boolean | خیر | 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_url | string | خیر | 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