Retrieve data

get

https://api.super.ai/v1/data

Use this endpoint to pull information on a specified piece of data, a folder, or all the data you have in storage. If you do not provide a path or data ID, the response will include information on all the data you have uploaded (assuming you don't use other parameters to limit your results).

Query Params

dataId

int32

Unique identifier for the piece of data you want to receive information on. You can append multiple dataId parameters to pull information on multiple pieces of data at once.

path

array of strings

Folder path of the data you want to retrieve. This must be URL encoded (e.g., folder1/folder2/images/ becomes folder1%2Ffolder2%2Fimages%2F).

path

signedUrl

boolean

Whether you also want to retrieve the signed URLs (if they are any) for the data(sets) you retrieve

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 data objects per page you want to receive. Without this parameter, the default is 250.

sortBy

string

Criteria by which the response objects are sorted. Available options: id (the data point identifier), path (the folder structure and filename), mimeType (the standardized media type and subtype, e.g., image/jpeg), created (the time the job was submitted to super.AI), and updated (when the data was last altered, generally meaning deleted). 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. The default sort

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

400400

401401