Skip to main content
POST
Cancel agent

Authorizations

Authorization
string
header
required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$
projectID
string
required
Pattern: ^proj_[a-z2-7]{26}$
agentID
string
required
Pattern: ^agt_[a-z2-7]{26}$

Body

application/json
actor
object

External actor to attribute this cancelation to, upserted by (provider_tenant_id, provider_user_id) atomically with the cancelation; a rejected request writes no actor. Only allowed for non-user principals; requests authenticated as a user must omit it and are attributed to the user's omnara actor.

Response

Agent canceled.

event
object
required
runtime_cancel_requested
boolean
required

Whether this request created or observed a durable runtime cancel request. Immediate delivery is best effort; runtime-lock renewal observes the durable request.

affected
boolean
required

Whether this request changed any cancelable work.

actor_id
string

Actor the cancelation was attributed to. Absent when the request had no actor attribution.

Pattern: ^actr_[a-z2-7]{26}$