Skip to main content
GET
Get an agent by ID
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/agents/get?id=<agentId> returns one Agent by its agentId or its definition id. A missing agent, a PERSONAL agent, and an agent you may not read at its home org unit all answer 404 resource_missing with the message Agent not found, so a caller cannot tell them apart. For the configuration the Console’s detail page shows (prompt, model, run limits, memory, skills and tool sets), see Get an agent’s configuration.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

agentId
string
required

Response

Agent detail

data
object
required

An agent the caller may read at its home org unit. Prompts, files, memory, tools, identity attestation, the home org unit and the stored principal are not exposed; absent optional values are null.

meta
object
required