Skip to main content
POST
Read agent configuration

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

agents:read

Agents, runs, configuration, handbook, memory, tone examples, scheduled tasks, and connected-service research.

Body

application/json
agentId
string
required

Agent id from list_agents.

Required string length: 1 - 64
section
enum<string>

Use scheduled_runs to list this agent's existing schedules before creating another; omit for settings.

Available options:
scheduled_runs
scheduleId
string

With section=scheduled_runs, read one schedule's full prompt using an ID from the schedule list.

integrationType
string

Omit to read agent-wide settings, including Smart/Lite type. Supply an integration type only to read that integration's settings.

cursor
string
connectedAccount
string

Response

Success

configuration
object
required