Skip to main content
POST
Cancel conversation execution

Authorizations

Authorization
string
header
required

Pass a user JWT or a oag_ User API Key on the Authorization: Bearer <token> header. Both are validated by openapi-gateway against the Auth service.

Both credential types are user-scoped: every key (and every JWT) is bound to exactly one owner, and every route grants the caller full access to that owner's own resources. Cross-tenant access is denied by owner-ACL inside the handlers — there is no per-route scope vocabulary on this API.

Removed in v1.1.0: the legacy agents:* / tasks:* / files:* / instances:* scope set has been dropped together with the 403 insufficient_scope error. Existing oag_ keys automatically gain full owner-level access and do not need to be re-issued. SDK calls that previously passed scopes to createAPIKey should drop the argument. See the changelog at the bottom of this spec for the full migration note.

Headers

Idempotency-Key
string
Required string length: 1 - 128
X-BeeOS-Operation-Id
string<uuid>

Path Parameters

agentId
string
required
Maximum string length: 128
conversationId
string
required
Maximum string length: 128

Body

application/json
target_message_id
string
required
Required string length: 1 - 128
reason
string

Response

Durable session/cancel operation accepted

success
boolean
required
data
object
required