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

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

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የsites.view ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

የድርጅትዎ መታወቂያ የሚገባበት ቦታ

ይህ ማቆሚያ ነጥብ org_id እንደ ጥያቄ መለኪያ ይወስዳል። እሱን ይተውት እና ጥሪው አጠቃላይ የኪራይ ንዑስ ዛፍዎን ይሸፍናል፤ ጥሪውን ወደ አንድ ድርጅት ለማጥበብ ይላኩት።

የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በAPI ኮንሶል ውስጥ ይክፈቱ

ዝርዝሮች

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

መለኪያዎች

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`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.

ምላሽ

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`tier`	`string`	አዎ	The tier this organization falls into.
`monthly`	`integer`	አዎ	Checks from the tier
`granted`	`integer`	አዎ	Extra checks granted by staff that have not expired.
`total`	`integer`	አዎ	`monthly` + `granted`.
`used`	`integer`	አዎ	Billable checks used this period. Ticket and staff checks are never counted.
`remaining`	`integer`	አዎ	—
`exhausted`	`boolean`	አዎ	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`	አይ	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`	አይ	Out of allowance AND out of credit — the only state in which a self-serve check is actually refused.
`in_good_standing`	`boolean`	አዎ	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`	አዎ	—

ይህ ማብቂያ ሊመልሳቸው የሚችሉ ስህተቶች

401 · 403 · 422 · 429

GET /v1/ai/site-agent/allowance