Skip to main content
GET
Get an agent's configuration
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/getConfiguration?id=<agentId> returns the configuration the Console’s agent detail page shows, for one agent by its agentId (slug) or definition id.

Authority

You need agents:read at the agent’s home org unit (or an org unit above it). A missing agent, a PERSONAL agent, an agent with no home and an agent you may not read at its home all answer the same 404 resource_missing with the message Agent not found, so a caller cannot tell them apart. An unavailable agent store answers 500, never 404. id is required once: a missing or repeated id is 400 bad_request.

What it returns

  • Identity and classification: id, agentId, name, description, status, subType, executionModel, governanceTier (system, worker or personal, as the Console shows it), identity (emoji, theme), purpose, tags, documentationUrl, version, activeVersionId.
  • Model: model (default, allowOverride, minContextWindow) and fallbackChainId.
  • Prompt and run limits: prompt (core, extension) and constraints (maxToolCalls, timeoutSeconds, maxTokensPerTurn).
  • External inference controls: allowExternalSystemPrompts, allowExternalToolMessages, externalModelAllowlist.
  • Memory: memory (type, scope, contextBudgetFraction, sessionMaxSummaryTokens, channelMaxSummaryTokens), or null when the agent uses the defaults.
  • Skills and tool sets: toolCredentialPreference (user or agent), and skills and toolSets by their natural keys: what the agent holds, granted minus denied.
  • updatedAt.
Every field is present; an unset value is null, [] or the Console’s default (false, agent).

What is withheld

Never the agent’s LLM-proxy key (virtualKeyId, which works as a bearer credential), its user, principal, owner or creator ids, its NHI id, its identity attestation, its files, its embedding, its synthesis request or builder channel, or its exemplars. GET /api/v2/agents/get stays the smaller catalog view.

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

The agent's slug (agentId) or definition id.

Minimum string length: 1

Response

Get an agent's configuration

data
object
required
meta
object
required