Cancel multiple jobs

post

https://api.super.ai/v1/apps/{app_id}/cancel

Use this endpoint to cancel multiple jobs that have been submitted but not yet processed. If you do not apply any filters, this endpoint cancels all jobs for the specified project.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

The universal unique identifier (UUID) of the project for which you want to create the job. You can find this in the super.AI dashboard URL of your project.

Query Params

createdStartDate

date

UTC timestamp of the earliest job start date for cancelation

createdEndDate

date

UTC timestamp of the latest job start date for cancelation

statusIn

array of strings

Filter by current status. Available options: SCHEDULED, IN_PROGRESS, SUSPENDED, PENDING.

statusIn

tags

batchId

string

Filter by job batch, i.e., jobs created with a single request

metadataSearch

string

Filter jobs by metadata. Enter the any text that appears within your metadata and only jobs that contain that text string in their metadata will be returned.

idSearch

string

Filter by a specific ID. This searches job IDs, job UUIDs, and metadata IDs.

idGreaterThan

int32

Filter by the lowest job ID number

idLessThan

int32

Filter by the highest job ID number

inputPath

string

The path within the input JSON that you want to search. Use {} for root; use the format {a.b.0} to specify a path within the JSON (where 0 is the index number if the input features an array). E.g., if you want to search an input key named vendor that is nested within a product key, specify it using the format {product.vendor}. Must be used together with inputMatchType and inputValue.

inputMatchType

string

The type of search you want to conduct. Possible values: IS, CONTAINS, IS_NOT, CONTAINS_NOT, IS_NOT_EMPTY. Must be used together with inputPath and inputValue.

inputValue

string

The search term that you are looking for within your input. Must be used together with inputPath and inputMatchType.

Responses

200200

400400