hosting
GET /v1/sites/{siteId}/ide-assist/credit
What the site's web editor shows beside its assistant.
Authentification
Cet point de terminaison est public. Il ne nécessite aucun identifiant ni aucune organisation : c'est ce que notre propre site marketing et nos moteurs de réponse IA lisent.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ide-assist/creditConnecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
available | boolean | Oui | 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 | Non | ISO 4217, for the amounts below. |
balance_micros | integer | Non | Purchased credit held, in USD micros. ⛔ Not what they can spend — see spendable_micros. |
spendable_micros | integer | Non | 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 | Non | What is left of today's included allowance, in USD micros. |
is_low | boolean | Non | 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 | Non | Nothing can fund the next call — no credit and no allowance left. |
on_byo | boolean | Non | 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 | Non | 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,… |
Erreurs que cet point de terminaison peut renvoyer
404