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

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar sites.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`org_id (query)`	`Uuid`	Hayır	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`tier`	`string`	Evet	The tier this organization falls into.
`monthly`	`integer`	Evet	Checks from the tier
`granted`	`integer`	Evet	Extra checks granted by staff that have not expired.
`total`	`integer`	Evet	`monthly` + `granted`.
`used`	`integer`	Evet	Billable checks used this period. Ticket and staff checks are never counted.
`remaining`	`integer`	Evet	—
`exhausted`	`boolean`	Evet	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`	Hayır	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`	Hayır	Out of allowance AND out of credit — the only state in which a self-serve check is actually refused.
`in_good_standing`	`boolean`	Evet	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`	Evet	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 422 · 429