Jump to Content
Documentation
API reference
What's new
Documentation
Recipes
API reference
What's new
Documentation
API reference
What's new
Log In
API reference
Log In
API reference
Super.AI API: Introduction
All
Pages
Start typing to search…
JUMP TO
Full API reference
Super.AI API: Introduction
Authentication
Callbacks
Job callbacks
Job batch callbacks
Image Redact
Description
Create Image Redact jobs
post
Jobs
The job object
Create jobs
post
Queue jobs for processing
post
Retrieve a single job object
get
Retrieve multiple job objects
get
Retrieve a job output
get
Retrieve job feedback and output
get
Retrieve all information on multiple jobs
post
Retrieve job history
get
Retrieve historical job output
get
Cancel a job
post
Cancel multiple jobs
post
Resubmit a job
post
Resubmit multiple jobs
post
Review or edit the output of a job
patch
Delete a job
del
Delete multiple jobs
del
Add tags to job
put
Add tags to multiple jobs
put
Delete tags from job
del
Delete tags from multiple jobs
del
Job batches
The job batch object
Retrieve a batch object
get
Retrieve job IDs from a batch
get
Retrieve information on unprocessed job batches
get
Resubmit a Job Batch
post
Storage
The data object
Upload data
post
Retrieve data
get
Delete data
del
Download a `data://` URL
get
Ground truth data
The ground truth data object
Upload ground truth data
post
Convert a job to ground truth data
post
Retrieve a ground truth data point
get
Retrieve multiple ground truth data points
get
Edit a ground truth data point
patch
Delete a ground truth data point
del
Workers
The worker object
Create a worker
post
Add a worker to a project
post
Retrieve workers from a project
get
Retrieve workers from an account or organization
get
Update a worker's role
patch
Delete a worker from a project
del
Delete a worker
del
Worker groups
The worker group object
Create a worker group
post
Add a worker group to a project
post
Retrieve worker groups from a project
get
Retrieve worker groups from an account or organization
get
Update a worker group's role
patch
Update a worker group
patch
Delete a worker group from a project
del
Delete a worker group from an account or organization
del
Retrieve a worker group
get
Measurements
Measurer API Overview
metrics
Update measurer configuration
patch
Get measurer configuration
get
Get measurements for the given app_id
get
Create a new operation for the measurer
post
Get all operations for the measurer
get
Delete a specific operation for the measurer
del
Get a specific operation for the measurer
get
Cancel a specific operation for the measurer
patch
Get measurer app metrics
get
super.AI API
app instances
Get application tags
get
Update application tag
patch
Delete application tag
del
Get application tag
get
Create application tag
put
Create a new app
post
List all apps
get
check if model confidence score is available for the app
get
Download job data generated by task
get
update Owner activity for an app
put
Patch an app given its identifier
patch
Fetch a given resource
get
Clone app
post
Get Job with feedback stats for app id
get
Fire an async task to get all data
post
Get labeling jobs cost over time given an app instance id [MOCK]
get
Get labeling jobs metric over time given an app instance id [MOCK]
get
Get labeling jobs time over time given an app instance id [MOCK]
get
Get labeling progress stats given an app instance id [MOCK]
get
Get labeling time left given an app instance id [MOCK]
get
Fetch a given resource
get
Get application plans metadata
get
Get application selected plan
get
Updates app super tasks
patch
Fetch app super tasks
get
Get application tasks median completion
get
Fetch a template given app
get
app templates
List all templates (Tags param is mock)
get
/v1/templates/search
get
/v1/templates/tags
get
Fetch a given resource
get
Create or update a template given its full qualified name
put
Returns 204 if template is available
get
Fetch the requested sample app with its input data
get
authentication
Lists the current customers of super
get
List all apps of customer
get
Create a new user
post
Fetch a given resource
get
Update a user given its identifier
put
List all API keys
get
Create a new API key
get
Delete a API key
get
Get user status
get
Get aws keys
get
Set user as onboarded
post
Get user status
get
baseline data
Create a new baseline data for a given api_id
post
Get baseline data for given api_id
get
Create a baseline data from a completed job
post
Patch baseline data given an id and api_id
patch
Delete baseline data
del
Patch baseline data given an id
patch
Delete baseline data
del
Get baseline data given a baseline data id
get
collaborator
Invite a collaborator
post
List collaborations
get
List collaborations
get
List roles of user
get
Get invitations
get
Patch a collaboration given an id
patch
Delete a collaborator given an id
del
Get a collaboration given an id
get
Checks collaborator invite user exists
get
Accept invitation
post
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
create new data
post
Delete a data
del
Query data
get
create/upload new data
put
Create new AI task data
post
Generate a signed url for collaborator task data
get
Generate signed url for given data name and ttl
get
Generate a signed url for task data
get
Generate a signed url for task data
get
jobs
Cancel all jobs in app given app identifier and filters
post
Delete all jobs in app given app identifier and filters
del
Create a new job
post
Shows a list of all jobs, within app app_id [TAG ATTRIBUTE IS MOCK]
get
Get collaborator jobs by app
get
Get jobs state count by app and filters
get
Get job ids to label
get
Remove tags from jobs by app and filters
del
Add tags to jobs by app and filters
put
Shows a list of all jobs with one recently added feedbackmessage, within app app_id
get
Get collaborator jobs by app to label
get
Relabel all jobs in app given app identifier and filters
post
Start all jobs in app given app identifier and filters
post
Total job count including deleted and relabeled
get
Get job batches not processed
get
Get job batch
get
Get job ids of batch
get
Fetches the feedback tags associated with the app
get
Updates the the feedback message view state of the owner
post
Create a feedback message between owner and worker for a job
post
Reads feedback messages for a jobId
get
Resolve job with big payload
post
Retrieve job with big payload
get
Retrieve child job with big payload by sequence
get
/v1/jobs/labeler-feedback
post
Fetch a job given its identifier
get
Delete a job given its identifier
del
Fetch a job given its identifier
get
Get paginated list of job audit
get
Cancel the given job resource
post
Complete parked/pending job
post
Get current job labelers
get
Get diff of job versions
get
Get paginated list of job history
get
Get job history response
get
Fetch the job info for a job given its identifier
get
Label collaborator job
post
Relabel the given job resource
post
Get response (output) for the given job resource
get
/v1/jobs/{job_id}/review
patch
Start the given job
post
tags
Delete a tag given its identifier [MOCK]
del
Fetch a tag by its id [MOCK]
get
Update a tag given its identifier [MOCK]
put
tasks
Retrieve resolved task with big payload by job and sequence
get
/v1/task-big-payload/{worker_id}/{task_id}
post
/v1/task-big-payload/{worker_id}/{task_id}
get
/v1/taskqueue/feedbackoptions/{worker_id}/{task_id}
get
/v1/taskqueue/filter/{worker_id}
get
/v1/taskqueue/history/{worker_id}
get
/v1/taskqueue/message/{worker_id}/training/{training_id}
get
/v1/taskqueue/pendingmessage/{worker_id}
get
/v1/taskqueue/pendingmessage/{worker_id}/training/{trainingId}
get
/v1/taskqueue/pendingmessage/{worker_id}/{conversation}
get
/v1/taskqueue/tasks/{job_id}
get
/v1/taskqueue/tasks/{worker_id}/{task_id}
patch
collaborator tasks
Retrieve resolved collaborator task with big payload by job and sequence
get
/v1/collaborator-task-big-payload/{task_id}
post
/v1/collaborator-task-big-payload/{task_id}
get
/v1/collabtaskqueue/in-progress/{app_id}
get
/v1/collabtaskqueue/label/{app_id}
get
/v1/collabtaskqueue/task/{task_id}
patch
/v1/collabtaskqueue/task/{task_id}
get
/v1/collabtaskqueue/task/{task_id}/alive
post
heroes
Get hero information
get
Adds hero to disabled list of heroes per app
post
Removes hero from disabled list of heroes per app
del
Update hero status
post
organizations
Shows a list of all organizations that the user belongs to
get
Get organization invitations
get
Shows a list of all apps that belongs to organization
get
Creates an invitation to organization
post
Accept an invitation to organization
post
Checks organization invite user exists
get
Shows a list of all members that belongs to organization
get
Updates a members that belongs to organization
patch
Deletes a members that belongs to organization
del
workers
Get workers of app
get
Get worker for app by username
get
Update worker app role
patch
Add worker to app
post
Delete worker from app
del
Creates a worker
post
Shows a list of all workers that the user or org owns
get
Get worker invitations
get
Delete worker
del
Accept worker invitation
post
Checks worker invite user exists
get
worker groups
Get worker groups of app
get
Update worker group app role
patch
Add worker group to app
post
Delete worker group from app
del
Creates a worker group
post
Shows a list of all worker groups that the user or org owns
get
Updates a worker group
patch
Delete worker group
del
Get worker group
get
operations
Shows a list of all operations, within app app_id
get
Archive operation within app app_id by operation id
del
Get operation within app app_id by operation id
get
Generates download jobs url by app id and operation id
post
Retry failed operation by app id and operation id
post
task-info
Get task worker distribution by app
get
Trigger task download operation by app id and filters
post
Get tasks of job
get
Get single task of job
get
Review task of job
patch
task-operations
Shows a list of all task operations, within app app_id
get
Get task operation by app app_id by operation id
get
Generates download jobs url by app id and operation id
post
task templates
Fetch a given resource
get
Create or update a template given its full qualified name
put
integrations
/v1/integrations/apps/{app_id}/data/uploaded
post
/v1/integrations/apps/{app_id}/submit-job
post
schema
Generate Schema
post
inbox
/v1/inbox/verify/{app_id}
post
/v1/inbox/verify/{app_id}
get
/v1/inbox/{app_id}
del
/v1/inbox/{app_id}
post
/v1/inbox/{app_id}
get
field_datasets
Create a field dataset given its application UUID and field ID
post
Fetch a field dataset by its application UUID and field ID
get
Append to a field dataset given its application UUID and field ID
put
Download a field dataset as CSV
get
Fetch all field datasets by application UUID
get
update field datasets by application UUID and field id
post
Powered by
Super.AI API: Introduction
Ask AI
