Cancel Task

DELETE

/api/v1/task/{task_id}

This endpoint from PiAPI's Drean Machine API allows you to cancel a task hat have not yet started, i.e., tasks in the pending state.
Once a task has entered the processing state, it can no longer be canceled.

Request

Path Params

task_id

string

required

The task_id of the task you want to cancel.

Header Params

x-api-key

string

required

Your API Key used for request authorization

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

integer

required

message

string

required

Example

{
  "code": 200,
  "message": "task 170b8a42-xxxx-xxxx-xxxx-xxxxxxx8c79e canceled"
}

Modified at 2024-10-17 10:24:21

Cancel Tasks

Create Task