API Referenceai

Get an AI credential

View as Markdown
Get one saved BYOK AI credential.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

credentialIdstringRequired

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response

OK
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
hasApiKeyboolean
idstring
namestring1-200 characters
providerenum
statusenum
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
baseUrlstringOptionalformat: "uri"
defaultModelstringOptional
subaccountIdstringOptional1-64 characters
Opaque identifier for a BCTRL subaccount.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error