Skip to main content
GET
Get an agent's configuration

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Path Parameters

agentId
string
required

The agent id to inspect. Must belong to the current scope (workspace, or team for team-scoped explorers).

Response

Success. Empty result sets are also 200.

The agent's full configuration. Credential and API key values never appear — toolCredentials reports the type and which fields are set, and MCP auth is referenced by secret id.

id
string
required
type
string
required
name
string
required
handle
string
required

The agent's unique address for email, Slack and other channels.

customerId
string
required
enabled
boolean
required
access
object
required

Who may reach the agent in the portal.

instructions
object
required

Standing instructions, keyed by section. Versioning metadata is flattened away here.

capabilities
(string | object)[]
required

Mixed array: plain strings, or objects for capabilities that carry settings.

scheduledTriggers
object[]
required
toolCredentials
object[]
required
isEvalClone
boolean
required
description
string
imageUrl
string
groupId
string
phase
string

Stored lifecycle phase — only present on agents someone promoted, and kept even if the workspace later switches phases off.

effectivePhase
string

"production" or "sandbox"; absent when the workspace has lifecycle phases switched off, in which case nothing is phase-gated.

timeZone
string

IANA name; the default for this agent's scheduled triggers.

tags
string[]
criticality
string
valueEntries
object[]

Value per workspace value-capture category.

dailyCreditLimit
number

Absent means the agent inherits the workspace default.

adminOnly
boolean
adminRestriction
string

"none", "team" or "workspace".

agentDiscoverability
string

Which other agents may contact this one.

crossTeamSharing
object
llmPreferences
object

Model and effort per context; an unset context inherits from the one above it.

disabledLlmModels
string[]
httpApis
object[]

API Capabilities on this agent. Entries whose config was deleted are dropped.

mcpServers
object[]
agentEvals
object[]

See /agents/{agentId}/evals for the full eval shape.

evalSettings
object
mcpServerExposed
object
httpApiExposed
object
documentApiExposed
object
webhooksExposed
object
widgetExposed
object
allowWorkspaceKeys
boolean

Whether workspace keys may call this agent's exposed APIs.

publicSharing
object
voice
object
voicePhoneNumber
string
smsPhoneNumber
string
chatStartMode
string
chatStartMessage
string
diaryEnabled
boolean
messageLogEnabled
boolean
showTokenOptimisationInfo
boolean
dreaming
object
notificationSettings
object
clonedFromAgentId
string
createdAt
string

ISO 8601 timestamp.

updatedAt
string

ISO 8601 timestamp.

{key}
any