API Referencetools

Get a tool

View as Markdown
Get one custom tool definition, including its schemas, execution method, status, and metadata.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

toolRefstringRequired

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
BuiltinToolobject
OR
CustomToolobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error