DocumentationAPI referenceWhat's new
API reference

Add tags to multiple jobs

put
https://api.super.ai/v1/apps//jobs/tags

Use this endpoint to add tags to multiple jobs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Searching inputs and outputs

The inputPath, inputMatchType, and inputValue parameters must be used in conjunction in order to search your input JSON data. Likewise, you need to specify responsePath, responseMatchType, and responseValue to search your output data.

❗️

Tagging a single job

If you want to tag single job by ID, you should not be using the idSearch parameter, since it does not guarantee to work on a unique job. We recommend using another endpoint: Add tags to job by job id

Path Params
string
required

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

Query Params
date

UTC timestamp of the earliest job start date for adding tags

date

UTC timestamp of the latest job start date for adding tags

date

UTC timestamp of the earliest job completion date for adding tags

date

UTC timestamp of the latest job completion date for adding tags

tags
array of strings

Filter by tags, which are manually set text tags that allow you to label and group your data points for later reference

tags
statusIn
array of strings

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

statusIn
string

Filter 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.

string

Filter by whether the job output has been reviewed. Available options: CORRECT, NOT CORRECT, and REVIEWED.

string

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

string

Filter by a specific ID. This searches job IDs, job UUIDs, and metadata IDs. Beware that this can lead to unintentially tagging more jobs than expected, since there could be random substring matches in the UUID or metadata. We recommend using the single job tagging endpoint based on ID.

int32

Filter by the highest job ID number

int32

Filter by the lowest job ID number

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.

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.

string

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

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.

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.

string

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

Body Params
tags
array of strings

The tags that you want to add to the jobs

tags
Responses

Updated 10 months ago

What's next

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

What's next

Did this page help you?