ai
GET /v1/ai/summary
The organization's AI position — balance, funding route, usage.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу sites.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/ai/summary \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Everything the AI page needs in one request: the Zinn® AI credit balance, which funding route the next call would take, the org's own provider keys, 30 days of metered usage and how many agent proposals are waiting. funding_route is derived from the same function the next call will use, never re-implemented — a screen that computes its own answer eventually tells a customer they are on their own key while we bill them. 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. Omitting it in a multi-org account is a 422 that says… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
credit_balance_micros | integer | Да | — |
credit_currency | string | Да | The ledger's denomination. USD, with display converted per request off the cached FX rates — the same pattern listExtras uses, and for the same reason: every provider quotes us… |
funding_route | string<byo, credits, included, none, mixed> | Да | Which route the NEXT call would take, for the organization as a whole. none means there is no way to fund one. mixed is the honest answer when the providers disagree, and it… |
funding_routes | AiProviderFunding[] | Да | Who pays for the next call to each provider, and whether its key works. |
included_daily_micros | integer | Да | — |
included_remaining_micros | integer | Да | — |
credentials | AiCredential[] | Да | — |
usage_30d | AiUsageLine[] | Да | — |
open_proposals | integer | Да | — |
site_builder | SiteBuilderTrial | Да | The one-time free allowance for the AI site builder. One grant per organization, for ever — not monthly, and not per site. granted is true because the credit was actually… |
Грешке које ова крајња тачка може вратити
401 · 403 · 422 · 429