Jump to Content

Documentation API reference What's new

Home Documentation Recipes API reference What's new Discussions

Documentation API reference What's new Log In

API reference

Full API reference

Super.AI API: Introduction
Authentication
Callbacks

Image Redact

Description
Create Image Redact jobspost

Jobs

The job object
Create jobspost
Queue jobs for processingpost
Retrieve a single job objectget
Retrieve multiple job objectsget
Retrieve a job outputget
Retrieve job feedback and outputget
Retrieve all information on multiple jobspost
Retrieve job historyget
Retrieve historical job outputget
Cancel a jobpost
- Cancel multiple jobspost
Resubmit a jobpost
Resubmit multiple jobspost
Review or edit the output of a jobpatch
Delete a jobdelete
- Delete multiple jobsdelete
Add tags to jobput
- Add tags to multiple jobsput
Delete tags from jobdelete
- Delete tags from multiple jobsdelete

Job batches

The job batch object
Retrieve a batch objectget
Retrieve job IDs from a batchget
Retrieve information on unprocessed job batchesget

Storage

The data object
Upload datapost
Retrieve dataget
Delete datadelete
Download a `data://` URLget

Ground truth data

The ground truth data object
Upload ground truth datapost
Convert a job to ground truth datapost
Retrieve a ground truth data pointget
Retrieve multiple ground truth data pointsget
Edit a ground truth data pointpatch
Delete a ground truth data pointdelete

Workers

The worker object
Create a workerpost
Add a worker to a projectpost
Retrieve workers from a projectget
Retrieve workers from an account or organizationget
Update a worker's rolepatch
Delete a worker from a projectdelete
Delete a workerdelete

Worker groups

The worker group object
Create a worker grouppost
Add a worker group to a projectpost
Retrieve worker groups from a projectget
Retrieve worker groups from an account or organizationget
Update a worker group's rolepatch
Update a worker grouppatch
Delete a worker group from a projectdelete
Delete a worker group from an account or organizationdelete
Retrieve a worker groupget

Measurements

Measurer API Overview
metrics

super.AI API

app instances
app templates
authentication
baseline data
collaborator
collaborator metrics
- Get all collaborators satisfying the given apiId and period range [MOCK]get
- Get the collaborator metrics for given apiId and period range [MOCK]get
data
jobs
tags
tasks
collaborator tasks
heroes
organizations
workers
worker groups
operations
task-info
task-operations
task templates
- Fetch a given resourceget
- Create or update a template given its full qualified nameput
integrations
- /v1/integrations/apps/{app_id}/data/uploadedpost
- /v1/integrations/apps/{app_id}/submit-jobpost
schema
- Generate Schemapost
inbox
field_datasets

Powered by

Full API reference

Super.AI API: Introduction
Authentication
Callbacks

Image Redact

Description
Create Image Redact jobspost

Jobs

The job object
Create jobspost
Queue jobs for processingpost
Retrieve a single job objectget
Retrieve multiple job objectsget
Retrieve a job outputget
Retrieve job feedback and outputget
Retrieve all information on multiple jobspost
Retrieve job historyget
Retrieve historical job outputget
Cancel a jobpost
- Cancel multiple jobspost
Resubmit a jobpost
Resubmit multiple jobspost
Review or edit the output of a jobpatch
Delete a jobdelete
- Delete multiple jobsdelete
Add tags to jobput
- Add tags to multiple jobsput
Delete tags from jobdelete
- Delete tags from multiple jobsdelete

Job batches

The job batch object
Retrieve a batch objectget
Retrieve job IDs from a batchget
Retrieve information on unprocessed job batchesget

Storage

The data object
Upload datapost
Retrieve dataget
Delete datadelete
Download a `data://` URLget

Ground truth data

The ground truth data object
Upload ground truth datapost
Convert a job to ground truth datapost
Retrieve a ground truth data pointget
Retrieve multiple ground truth data pointsget
Edit a ground truth data pointpatch
Delete a ground truth data pointdelete

Workers

The worker object
Create a workerpost
Add a worker to a projectpost
Retrieve workers from a projectget
Retrieve workers from an account or organizationget
Update a worker's rolepatch
Delete a worker from a projectdelete
Delete a workerdelete

Worker groups

The worker group object
Create a worker grouppost
Add a worker group to a projectpost
Retrieve worker groups from a projectget
Retrieve worker groups from an account or organizationget
Update a worker group's rolepatch
Update a worker grouppatch
Delete a worker group from a projectdelete
Delete a worker group from an account or organizationdelete
Retrieve a worker groupget

Measurements

Measurer API Overview
metrics

super.AI API

app instances
app templates
authentication
baseline data
collaborator
collaborator metrics
- Get all collaborators satisfying the given apiId and period range [MOCK]get
- Get the collaborator metrics for given apiId and period range [MOCK]get
data
jobs
tags
tasks
collaborator tasks
heroes
organizations
workers
worker groups
operations
task-info
task-operations
task templates
- Fetch a given resourceget
- Create or update a template given its full qualified nameput
integrations
- /v1/integrations/apps/{app_id}/data/uploadedpost
- /v1/integrations/apps/{app_id}/submit-jobpost
schema
- Generate Schemapost
inbox
field_datasets

Powered by

/v1/taskqueue/pendingmessage/{worker_id}

get https://api.prod-eu.super.ai/v1/taskqueue/pendingmessage/{worker_id}

Language

Credentials

Header

Click Try It! to start a request and see the response here!