Cancel messages

Cancel messages that have associated Temporal workflows (workflow-backed messages). Skips messages that have no workflow or are already finished.

POST /ai/messages/cancel

Cancel messages

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/ai/messages/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

uuids · string<uuid>[] · required

Message identifiers to cancel.

Minimum array length: 1

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

200

application/json

Successful response

The response is of type object.