For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The models this customer can actually route to: the active catalog filtered by the customer's effective controls (its own vendor, region and ZDR overrides over your organization's), its key-usage mode (under `BYOK_ONLY` / `CUSTOMER_ONLY` a vendor needs a usable provider key), and your organization's vendor access. Render a per-customer model picker from this instead of re-deriving the rules. A customer-scoped API key may read its own list.
Authentication
AuthorizationBearer
Your production key sent as a bearer token.
Path parameters
customer_idstringRequired
Response
Successful Response
scopestringOptional
scope_idstringOptionalformat: "uuid"
restrictions_activebooleanOptional
False when the effective controls restrict nothing; models is then the whole active catalog.
modelslist of objectsOptional
Models the customer can route to, sorted by id.
gated_model_idslist of stringsOptional
Models the controls allow but whose vendor your organization has not been granted access to. Routing refuses them today; access can be requested.
key_usage_modeenum or nullOptional
The key-usage mode the data plane enforces for this customer: its own, else your organization’s default for customers, else null (the organization’s own BYOK preferences apply).
Allowed values:
The models this customer can actually route to: the active catalog filtered by the customer’s effective controls (its own vendor, region and ZDR overrides over your organization’s), its key-usage mode (under BYOK_ONLY / CUSTOMER_ONLY a vendor needs a usable provider key), and your organization’s vendor access. Render a per-customer model picker from this instead of re-deriving the rules. A customer-scoped API key may read its own list.