Skip to main content
GET
Retrieve an agent

Authorizations

Authorization
string
header
required

A gbr_pat_ access token. Scopes are recorded on the token when it is minted.

Response

Retrieve one agent.

object
string
required

Always agent. Names the shape, so a value can be identified without knowing which call returned it.

Allowed value: "agent"
id
string
required

Ours. Pass it as agent.id when creating a session.

name
string
required

Yours, for recognising it. Not an identifier.

model
string | null

The model sessions from this agent run on, unless they override it.

model_credential_id
string | null

The connection to run on. Null uses the organization's default.

instructions
string | null

Standing instructions given to every session started from this agent.

Maximum string length: 32000
tools
object[]

Tools every session started from this agent gets, unless it replaces them. Secrets are withheld — see redacted on an entry.

text
object | null

Output shaping copied into every session started from this agent.

created_at
integer

Unix milliseconds.