Work

Cancel Work Turn

Ask the agent turn answering turn_id to stop. Cooperative and idempotent: it finishes its current step.

Allowed for the person who sent the turn's message and for an Owner or Admin. status is stopping, or unavailable (503) when nothing recorded the stop and nothing is running. 409 for a shared channel's turn.

post/work/conversations/{conversation_key}/turns/{turn_id}/cancel

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/work/conversations/{conversation_key}/turns/{turn_id}/cancel
  • Auth: HTTP bearer

Path parameters

conversation_keystring required

Conversation id (or channel key)

turn_idstring required

The id of the message the turn is answering.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataWorkChannelPayload required

A Work channel, chat, output, task, decision or activity document, as the app returns it.

Changes

No recorded changes to this operation across all 2 revisions of this API.