GET `/v1/ai/site-agent/allowance`

How many self-serve site checks are left this month.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen sites.view; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

One allowance per organization per calendar month, sized by how many sites the organization has — not per site. Free grants from staff are added to it. Checks run from the **support ticket form are free and unmetered** and never appear in `used`: a customer who has exhausted their allowance can still open a ticket and still gets a full check on their site. `in_good_standing` is false while an account is suspended or unpaid, which pauses metered checks only — the ticket path and previously-purchased results are unaffected. Requires `sites.view`.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`org_id (query)`	`Uuid`	Jo	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`tier`	`string`	Po	The tier this organization falls into.
`monthly`	`integer`	Po	Checks from the tier
`granted`	`integer`	Po	Extra checks granted by staff that have not expired.
`total`	`integer`	Po	`monthly` + `granted`.
`used`	`integer`	Po	Billable checks used this period. Ticket and staff checks are never counted.
`remaining`	`integer`	Po	—
`exhausted`	`boolean`	Po	The monthly allowance is spent. ⛔ This does NOT mean checks are refused — see `credit_checks`. Rendering "0 left" on this field alone tells a customer whose credit covers hundre…
`credit_checks`	`integer`	Jo	How many further checks the organization's Zinn® AI credit would cover once the allowance is gone. The allowance is the included tier of the one meter; beyond it a check is fu…
`exhausted_entirely`	`boolean`	Jo	Out of allowance AND out of credit — the only state in which a self-serve check is actually refused.
`in_good_standing`	`boolean`	Po	False while the account is suspended or unpaid. Pauses metered checks only — the ticket path stays free and previously-purchased results stay readable.
`period_start`	`string`	Po	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 422 · 429