For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The Python SDK and docs are currently in beta.
Report issues on GitHub.
Fields
Field
Type
Required
Description
Example
allowed_models
List[str]
➖
Optional allowlist of model slugs this credential may be used for. null means no restriction.
<nil>
allowed_user_ids
List[str]
➖
Optional allowlist of user IDs that may use this credential. null means no restriction.
<nil>
disabled
Optional[bool]
➖
Whether this credential is disabled.
false
is_fallback
Optional[bool]
➖
Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.
false
key
Optional[str]
➖
A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses.
