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

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

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin sites.view; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Inda ID ɗin kungiyar ku ke zuwa

Wannan mahadar ta na daukar org_id a matsayin sigar tambaya. Bar shi kuma kiran zai shafi daukacin rukunin haya naka; aika shi don takaita kiran zuwa kungiya daya tak.

Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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`.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`org_id (query)`	`Uuid`	A'a	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`tier`	`string`	Eh	The tier this organization falls into.
`monthly`	`integer`	Eh	Checks from the tier
`granted`	`integer`	Eh	Extra checks granted by staff that have not expired.
`total`	`integer`	Eh	`monthly` + `granted`.
`used`	`integer`	Eh	Billable checks used this period. Ticket and staff checks are never counted.
`remaining`	`integer`	Eh	—
`exhausted`	`boolean`	Eh	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`	A'a	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`	A'a	Out of allowance AND out of credit — the only state in which a self-serve check is actually refused.
`in_good_standing`	`boolean`	Eh	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`	Eh	—

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 422 · 429