身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/ai/site-agent/allowance \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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