Skip to navigation
API ReferenceAgents

Get an agent

Beta
View as Markdown
Read an Agent by ID or scoped name, including its promoted version and latest draft number.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

agentIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
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 headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
idstring
Unique agent identifier generated by BCTRL.
latestVersioninteger
metadataobject or null
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

object"agent"
promotedVersioninteger
spaceIdstring
Unique space identifier generated by BCTRL.
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
versionobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error