Job

  1. Each annotation request represents one unit of data that you would want to be annotated. We call all such request as Job and identified by job_id
  2. In case of non-sequential data, it would be one image or point cloud data.
  3. In case of sequential data, it would be an array of data links corresponding to the annotation request of interest

Batch
A batch is a way to organize multiple jobs under one batch_id. You can create multiple batches in a project and accordingly send the job with the corresponding batch ID.

tag
Each job creation request should have a tag which tells us what operation needs to be performed on that request. We'll share this tag with you during the integration process. Note that there can exist multiple tags in a single project in order to have different operations workflow.

Project
All the jobs, batches and tags are part of a single project identified by project_id. Each API request should have project_id to be passed in path URL

x-api-key
x-api-key is a secret key shared only with you as a client to ensure that only you are able to access your projects. To authenticate your account we expect the x-api-key key to be included in header in all API requests sent to our server.