Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
GET /v1/tenants/ returns one tenant — your own, or a direct child — with its current credit allocation set. Requires tenants:read.
GET /v1/tenants/{product_slug} returns a single tenant’s summary: name, domain, active status, billing mode, and its current allocation set with usage. product_slug may be your own key’s tenant, or any direct child of it.
GET https://api.knock2.ai/v1/tenants/{product_slug}
product_slug, or a direct child’s.curl https://api.knock2.ai/v1/tenants/acme_com_yourco_com \
-H "Authorization: Bearer YOUR_PARENT_API_KEY"
{
"data": {
"product_slug": "acme_com_yourco_com",
"name": "Acme Corp",
"domain": "acme.com",
"is_active": true,
"billing_mode": "parent",
"limits": []
}
}
tenants:read.
| Status | Meaning |
|---|---|
401 | Missing or invalid API key. |
403 | Your API key does not have the tenants:read scope. |
404 | No tenant found with this product_slug under your account — this includes tenants that exist but were provisioned by a different parent; ownership and existence are not distinguished in the response. |
429 | Rate limit exceeded. |