Resume a paused agent
Resumes a paused agent. Requires permission switches:use.
v2 compatibility notes
POST /api/v2/agents/resume resumes a paused agent. The body is exactly { id, reason }: id is the agent’s slug (agentId) and reason is 8 to 1,000 characters, recorded on the audit event. The audit event names the key’s owner for a Personal key, or the External App.
Authority
You needswitches:use at the agent’s home org unit, and agents:read there to see the agent. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable agent store is 500, never 404. Without switches:use at the home the answer is 403 permission_denied, recorded as a refused request. switches:use is never held by a Forge agent. Give it to a Personal key as an opt-in, short-expiry scope.
Status rules
The kill switch moves an agent only betweenactive and paused, and to deprecated (terminated):
pausepauses only anactiveagent: a terminated (deprecated),archived,draftor other agent is refused with409 invalid_state, so a pause then a resume never activates an agent that was not active. Pausing a paused agent changes nothing.resumerefuses a terminated or archived agent, and any agent that is not paused (adraftis published, never resumed), with409 invalid_state. Resuming an active agent changes nothing.terminaterefuses anarchivedagent with409 invalid_state. Terminating a terminated agent changes nothing.
200 with changed: false and writes no audit event.
Replay
With anIdempotency-Key, a repeat of the same request within 24 hours returns the recorded answer only while the slug still names the same agent definition, you may still read the agent at its home, and you still hold the route’s permission there (the agent_write replay rule). Otherwise the repeat is 409 conflict and the write never runs twice.
See Agent administration.Authorizations
Headers
1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.
1 - 255
