ai
GET /v1/ai/summary
The organization's AI position — balance, funding route, usage.
प्रमाणीकरण
बेरर टोकन म्हणून API की पाठवा. की मध्ये sites.view परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.
जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल
हे एंडपॉइंट org_id ला क्वेरी पॅरामीटर म्हणून स्वीकारते. ते वगळल्यास कॉल तुमच्या संपूर्ण टेनन्सी सबट्रीला कव्हर करतो; ते एका संस्थेपुरता कॉल मर्यादित करण्यासाठी पाठवा.
तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
curl -X GET https://api.zinndigital.com/v1/ai/summary \
-H "Authorization: Bearer zdk_live_…"साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील 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