ai
GET /v1/ai/summary
The organization's AI position — balance, funding route, usage.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/ai/summary \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
Everything the AI page needs in one request: the Zinn® AI credit balance, which funding route the next call would take, the org's own provider keys, 30 days of metered usage and how many agent proposals are waiting. funding_route is derived from the same function the next call will use, never re-implemented — a screen that computes its own answer eventually tells a customer they are on their own key while we bill them. 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. Omitting it in a multi-org account is a 422 that says… |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
credit_balance_micros | integer | 예 | — |
credit_currency | string | 예 | The ledger's denomination. USD, with display converted per request off the cached FX rates — the same pattern listExtras uses, and for the same reason: every provider quotes us… |
funding_route | string<byo, credits, included, none, mixed> | 예 | Which route the NEXT call would take, for the organization as a whole. none means there is no way to fund one. mixed is the honest answer when the providers disagree, and it… |
funding_routes | AiProviderFunding[] | 예 | Who pays for the next call to each provider, and whether its key works. |
included_daily_micros | integer | 예 | — |
included_remaining_micros | integer | 예 | — |
credentials | AiCredential[] | 예 | — |
usage_30d | AiUsageLine[] | 예 | — |
open_proposals | integer | 예 | — |
site_builder | SiteBuilderTrial | 예 | The one-time free allowance for the AI site builder. One grant per organization, for ever — not monthly, and not per site. granted is true because the credit was actually… |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 422 · 429