RunsCancel a run

Cancel a run

Cancels a non-terminal run. A cancelled run leaves ?decision=review and is never reported there again. No request body.

curl -X POST "https://api.deepvue.link/v1/runs/123e4567-e89b-12d3-a456-426614174000/cancel" \
  -H "Content-Type: application/json" \
  -H "client-id: YOUR_API_KEY" \
  -H "x-api-key: YOUR_API_KEY"
{
  "id": "1e30a341-cb3b-48b8-9992-99a1b436b8d9",
  "status": "cancelled"
}
POST
/v1/runs/{id}/cancel
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: client-id)
client-idstring
Required

Your Deepvue client identifier.

Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
Required

Your Deepvue API key. Secret - keep it server-side.

Your Deepvue API key. Secret - keep it server-side.
path
idstring
Required

The run's UUID.

Format: uuid
Request Preview
Response

Response will appear here after sending the request

Authentication

header
client-idstring
Required

API Key for authentication. Your Deepvue client identifier.

header
x-api-keystring
Required

API Key for authentication. Your Deepvue API key. Secret - keep it server-side.

Path Parameters

idstring
Required

The run's UUID.

Responses

idstring
statusstring
Allowed values:cancelled