Skip to main content
POST
/
v1
/
workflow-runs
/
{id}
/
cancel
Cancel a workflow run
curl --request POST \
  --url https://api.metal.ai/v1/workflow-runs/{id}/cancel \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>'
{
  "data": {
    "id": "665f1c2a9b1e4a0012a3b4c6",
    "workflowId": "665f1c2a9b1e4a0012a3b4c5",
    "status": "running",
    "input": {},
    "output": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-metal-client-id
string
header
required

The Client ID of your API key.

​
x-metal-api-key
string
header
required

The secret value of your API key.

Path Parameters

​
id
string
required

The workflow run id.

Response

The run was cancelled.

​
data
object