Agents API
Pause Agent
Pause a running agent
POST
Requires version 1.1.9 or later of the Archetype platform.
Overview
This endpoint pauses a running agent and returns the updated agent with statuspaused.
Only a running agent can be paused; anything else returns 409. Resume it later with POST /agents/instances/{agent_id}/resume.
Request
string
required
Agent
agt_ id.Response
Returns the paused agent.string
required
TypeID-encoded agent identifier (
agt_ prefix).string
required
Name of the agent (a run’s name is its bundle’s name).
string
required
Organization identifier the agent belongs to.
string
required
The bundle this agent was run from (provenance).
string
required
Human-readable pinned blueprint reference (its key), e.g.
osm.string
required
Immutable blueprint id the bundle pinned.
string
required
Agent lifecycle status;
paused after a successful pause.string
required
Creation timestamp (date-time).
object
The I/O binding this run was started with;
null when none is recorded.string
External executor’s job id for the current run (a JOS
job_ id). Present once the run has been dispatched.string
When the run started;
null before then.string
When the run finished;
null while unfinished.string
Failure detail;
null unless the run failed.Important Notes
- Pause is valid only from
running. Calling it on a paused or terminal agent returns409. - A paused agent can be resumed or canceled.