Cancel Tasks

DELETE

https://api.piapi.ai/api/v1/tasks

This endpoint from PiAPI's Dream Machine API allows you to cancel tasks of luma that were created before a specified time point.
Only tasks that have not yet started, i.e., tasks in the pending state, can be canceled. Once a task has entered the processing state, it can no longer be canceled.

Request

Query Params

created_before

integer

required

The time point at which you want to cancel tasks created before. It is Unix Timestamp.

Example:

1728570429

model

enum<string>

required

The model name of tasks you want to cancel. If you want to cancel tasks by all models(midjourney+suno+kling+luma), set to all

Allowed values:

lumamidjourneyklingsunoall

Example:

luma

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

curl --location --request DELETE 'https://api.piapi.ai/api/v1/tasks?created_before=1728570429&model=luma' \
--header 'x-api-key;'

Responses

🟢200Success

application/json

Body

code

integer

required

message

string

required

Example

{
    "code": 200,
    "message": "tasks created before 2024-10-12 02:38:06 +0000 UTC for model 'luma' have been canceled"
}

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

Get Task

Cancel Task