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

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

모든 ai 엔드포인트

모든 개발자 문서 →

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

조직 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 hundreds…
`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…
`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