Cancel task currently being executed by the API

August 8, 2024

Table of contents

1. Request Headers
2. Path parameter
3. Responses
4. Model
5. Examples
6. Try It

---

https://api.useapi.net/v1/runwayml/scheduler/taskId

Request Headers

Authorization: Bearer {API token}

• API token is required, see Setup useapi.net for details.

Path parameter

• taskId is required. Specify taskId you want to cancel.

Responses

• 204
• 400
• 401
• 404

• 204 No Content

• 400 Bad Request

  {
      "error": "<Error message>",
      "code": 400
  }
  

• 401 Unauthorized

  {
    "error": "Unauthorized",
    "code": 401
  }
  

• 404 Not Found

  {
    "error": "Unable to locate running taskId <taskId>"
  }
  

Model

{ // TypeScript, all fields are optional
  error: string
  code: number
}

Examples

• Curl
• JavaScript
• Python

• curl -H "Accept: application/json" \
       -H "Content-Type: application/json" \
       -H "Authorization: Bearer …" \
       -X DELETE "https://api.useapi.net/v1/runwayml/scheduler/taskId" 
  

• const taskId = "taskId to cancel"; 
  const apiUrl = `https://api.useapi.net/v1/runwayml/scheduler/${taskId}`; 
  const token = "API token";
  const data = { 
    method: 'DELETE',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json' }
  };
  const response = await fetch(apiUrl, data);
  const result = await response.json();
  console.log("response", {response, result});
  

• import requests
  taskId = "taskId to cancel" 
  apiUrl = f"https://api.useapi.net/v1/runwayml/scheduler/{taskId}" 
  token = "API token"
  headers = {
      "Content-Type": "application/json", 
      "Authorization" : f"Bearer {token}"
  }
  response = requests.delete(apiUrl, headers=headers)
  print(response, response.json())
  

Try It

API token taskId