Skip to main content

POST /cancel_job

Cancels a video analysis job, if the job is in a cancellable state (i.e., not yet picked to analysis from the queue).

Endpoint​

POST https://api-eu.valossa.com/core/1.0/cancel_job

Request Body​

FieldTypeRequiredDescription
api_keystringYesYour Valossa API key
job_idstringYesThe UUID of the job to cancel

Response​

A successful response returns HTTP 200 confirming the cancellation.

Examples​

curl​

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "YOUR_API_KEY",
    "job_id": "167d6a67-fb99-438c-a44c-c22c98229b93"
  }' \
  https://api-eu.valossa.com/core/1.0/cancel_job

Python​

import requests

response = requests.post(
    "https://api-eu.valossa.com/core/1.0/cancel_job",
    json={
        "api_key": "YOUR_API_KEY",
        "job_id": "167d6a67-fb99-438c-a44c-c22c98229b93"
    }
)

print(response.json())

JavaScript​

const response = await fetch("https://api-eu.valossa.com/core/1.0/cancel_job", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    api_key: "YOUR_API_KEY",
    job_id: "167d6a67-fb99-438c-a44c-c22c98229b93"
  })
});

const result = await response.json();
console.log(result);

Notes​

  • Cancelling a job does not delete it from your job list. Use DELETE /delete_job to remove a job entirely.