Create jobs

post

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

Use this endpoint to create new jobs for a specified project. You can create multiple jobs at once by adding each input as an object within a JSON array. The exact format of the JSON you need to provide is dictated by the project type that you are using. For an example of how to structure the input, open your super.AI dashboard, select the relevant project, hit Upload data in the top left and look for the JSON option.

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.

Body Params

callbackUrl

string

Where we will POST the job results.

inputsFileUrl

string

URL pointing to a JSON file (maximum size: 4 MB) containing an array of objects. Each object is an input. The value is a URL pointing to the relevant file or a raw text string. Consult the Upload data section of your project in the super.AI dashboard for information on how to structure the input.

inputs

json

JSON (maximum size: 4 MB) containing an array of objects. Each object is an input. The value is a URL pointing to the relevant file or a raw text string. The objects below are just possible examples. Consult the Upload data section of your project in the super.AI dashboard for information on which input object(s) and structure to use.

metadata

array

Manually set key-value pairs to decorate the job. Useful for storing additional information not provided by default. For example, you might want to pass your own internal ID for the data point (e.g., {"id": "{your-id}"}).

metadata

201201

400400

401401

409409

500500