Retrieve an agent
Authorizations
Path Parameters
The unique identifier of the agent
Response
Agent retrieved
An agent: standing instructions executed in an isolated sandbox with access to the environment's data, on a schedule or on demand. The same objects the app's Agents page manages.
Unique within the environment
The standing prompt every run executes
Reconciliations, data streams, users, and other agents whose context is resolved into every run's prompt. Mentioning an agent also teaches the run how to trigger it (see POST /agents/{id}/runs)
The model the agent runs on — resolved to the platform default when not set explicitly
manual agents only run when triggered (POST /agents/{id}/runs)
manual, hourly, daily, weekdays, weekly Required for daily, weekdays, and weekly cadences
0 <= x <= 23Required for every cadence except manual
0 <= x <= 590 = Sunday. Required for weekly cadence
0 <= x <= 6IANA timezone the schedule is evaluated in
Inactive agents are never scheduled but can still be run on demand
Whether this agent processes files dropped in the app. At most one active agent per environment can have this enabled.
Email output files matching delivery_file_pattern to delivery_recipients after each completed run
Case-insensitive glob selecting which output files are delivered