ai
GET /v1/ai/site-agent/allowance
How many self-serve site checks are left this month.
प्रमाणीकरण
बेरर टोकन म्हणून API की पाठवा. की मध्ये sites.view परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.
जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल
हे एंडपॉइंट org_id ला क्वेरी पॅरामीटर म्हणून स्वीकारते. ते वगळल्यास कॉल तुमच्या संपूर्ण टेनन्सी सबट्रीला कव्हर करतो; ते एका संस्थेपुरता कॉल मर्यादित करण्यासाठी पाठवा.
तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
curl -X GET https://api.zinndigital.com/v1/ai/site-agent/allowance \
-H "Authorization: Bearer zdk_live_…"साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह 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