Retrieve multiple job objects

get

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

Use this endpoint to retrieve the job objects for multiple jobs from a specified project.

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

page

int32

Page number from which you want to start your results. Only use this parameter if you are expecting a huge number of results. Without this parameter, the default is the first page, page 0.

size

int32

Number of jobs per page you want to receive. Without this parameter, the default is 250.

sortBy

string

Criteria by which the jobs are sorted. Available options: completed (time of job completion), created (time you submitted the job to super.AI), and status (current job status). Without this parameter, the default sorting method is id.

orderBy

string

Order in which your jobs are sorted. Available options: asc (ascending) and desc (descending). If you do not set this parameter, results will be in descending order.

createdStartDate

date

UTC timestamp of the earliest job start date for inclusion in results

createdEndDate

date

UTC timestamp of the latest job start date for inclusion in results

completedStartDate

date

UTC timestamp of the earliest job completion date for inclusion in results

completedEndDate

date

UTC timestamp of the latest job completion date for inclusion in results

statusIn

array of strings

Filter jobs by current status. Available options: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, and COMPLETED.

statusIn

correct

string

Filter jobs by whether an output has been marked as correct or not by a reviewer. Available options: true, false, and null. null means the job output has not yet been reviewed.

tags

notTags

array of strings

Filters out jobs having these tags.

notTags

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

onlyIfFeedback

boolean

Filter by whether jobs have labeler feedback attached

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.

responsePath

string

The path within the output 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 output features an array). E.g., if you want to search all output values, you can specify this using the format {label.selection.value}. Must be used together with responseMatchType and responseValue.

responseMatchType

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 responsePath and responseValue.

responseValue

string

The search term that you are looking for within your output. Must be used together with responsePath and responseMatchType.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

401401

402402

409409

500500