API Referenceai

Test an AI credential

View as Markdown
Test a saved AI credential before using it in hosted work.

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
checkedAtdatetime
RFC 3339 timestamp with a UTC offset.
okboolean
errorstringOptional
latencySecondsdoubleOptional>=0

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error