API docs by Redocly

AI Data Platform External API (1.0.0)

Download OpenAPI specification:

External API for the AI Data Platform endpoints.

Upload

Get signed urls for upload

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

query Parameters
count
integer [ 1 .. 10 ]
Default: 1

Number of signed urls to generate. Content-Type header is mandatory when uploading to the signed urls.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Download

Get signed urls for download

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

Request Body schema: application/json
paths
required
Array of strings [ 1 .. 1000 ] items

Responses

Request samples

Content type
application/json
{
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Batches

Create a new batch in a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

Max number of items to return

cursor
string

Cursor for pagination

page
string (KeysetPaginationDirection)
Enum: "NEXT" "PREV"

Direction to paginate

Request Body schema: application/json
required
name
required
string non-empty

Name of the batch (unique within project)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "priority": 0
}

List batches in a project with summary stats

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

query Parameters
limit
integer [ 1 .. 100 ]
Default: 20

Max number of items to return

cursor
string

Cursor for pagination

page
string (KeysetPaginationDirection)
Enum: "NEXT" "PREV"

Direction to paginate

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

Get batch prioritization configuration for a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Upsert batch prioritization configuration for a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

Request Body schema: application/json
required
required
Array of objects (BatchPriorityUpdate)

Batch priority values to save atomically

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Update a batch (name only)

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

batchID
required
integer <int64>
Request Body schema: application/json
required
name
string non-empty

New name for the batch (unique within project)

metadata
object

Batch metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "priority": 0
}

Exports

List exports for a space

Returns all exports for the given space, ordered by creation date (most recent first).

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

query Parameters
cursor
string

Cursor for pagination

page
string (KeysetPaginationDirection)
Enum: "NEXT" "PREV"

Direction to paginate

limit
integer [ 1 .. 100 ]
Default: 20

Max number of items to return

sortBy
string
Default: "createdAt"

Column to sort by

sortOrder
string (SortOrder)
Enum: "ASC" "DESC"

Sort order (asc or desc)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Create a COCO annotation export

Starts an async export of COCO annotation data as a zip file. Only one active export per space is allowed; returns 409 if an export is already running.

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters

Display name for this export

format
string (ExportFormat)
Value: "COCO_JSON"

Format of the exported data

projectIds
Array of strings <uuid> [ 1 .. 50 ] items [ items <uuid > ]

Optional list of project IDs to include in the export (1–50). When omitted, all projects in the space are exported.

batchIds
Array of integers <int64> <= 100 items [ items <int64 > ]

Optional batch IDs to filter work items (applied per-project). When omitted, all work items in the selected projects are exported.

createdAtFrom
string <date-time>

Include work items created on or after this timestamp (ISO 8601)

createdAtTo
string <date-time>

Include work items created on or before this timestamp (ISO 8601)

updatedAtFrom
string <date-time>

Include work items updated on or after this timestamp (ISO 8601)

updatedAtTo
string <date-time>

Include work items updated on or before this timestamp (ISO 8601)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "COCO_JSON",
  • "projectIds": [
    ],
  • "batchIds": [
    ],
  • "createdAtFrom": "2019-08-24T14:15:22Z",
  • "createdAtTo": "2019-08-24T14:15:22Z",
  • "updatedAtFrom": "2019-08-24T14:15:22Z",
  • "updatedAtTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "exportId": "85382188-14c3-47fd-b4ab-d4b86ccda514",
  • "name": "string",
  • "status": "PENDING",
  • "format": "COCO_JSON",
  • "createdBy": "string",
  • "downloadUrl": "string",
  • "error": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get export status

Returns the current status of an export. When COMPLETED, includes a pre-signed download URL valid for 7 days.

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

exportID
required
string <uuid>

Unique identifier for the export

Responses

Response samples

Content type
application/json
{
  • "exportId": "85382188-14c3-47fd-b4ab-d4b86ccda514",
  • "name": "string",
  • "status": "PENDING",
  • "format": "COCO_JSON",
  • "createdBy": "string",
  • "downloadUrl": "string",
  • "error": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete an export

Deletes an export and its associated zip file from storage. Can be called for exports in any status.

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

exportID
required
string <uuid>

Unique identifier for the export

Responses

Projects

List all projects

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Project by ID

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

projectID
required
string <uuid>

Unique identifier for the project

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "spaceID": "a32d76a4-ed5f-4743-8827-e55106d45f9d",
  • "dataType": "image, image_sequence",
  • "companyID": "8aa4932b-54c5-41e0-80aa-d1f56d573225"
}

WorkItems

Create signals

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

Request Body schema: application/json
required
signal
required
string (WorkItemSignal)
Enum: "start" "release" "complete" "cancel" "reopen"

Signal used for task assignment and workflow management.

signalOutcome
string (WorkItemSignalOutcome)
Enum: "OK" "NOT_OK"

Outcome reported for a completed signal.

taskType
string

Type of the task, e.g. "external_review". Required when signal is "complete".

required
Array of objects (WorkItemSignalItem) [ 1 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "signal": "start",
  • "signalOutcome": "OK",
  • "taskType": "string",
  • "workItems": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create a new work item under a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

Request Body schema: application/json
required
One of
assetUrl
required
string

Use assetID.

assetId
integer <int64> >= 0

Unique identifier for the asset associated with the work item.

batchId
integer <int64>

Optional batch identifier under the project to associate this work item with. Defaults to the project's 'Default' batch when omitted.

resultsUrl
string <url>

URL to access the results of the work item

taxonomyVersionId
string <uuid>

Version identifier for the taxonomy used for data.

object

Additional metadata for the work item which is stored but not processed

dueInSeconds
integer <int> [ 1 .. 2592000 ]

Deadline for the work item to be completed by in seconds. This is used for prioritization.

difficulty
integer <int> [ 0 .. 100 ]

Difficulty level of the work item for task assignment and prioritization.

assetType
required
string
Enum: "image" "video"
Array of objects (WorkItemLabelsItemBase)

Responses

Request samples

Content type
application/json
{
  • "assetUrl": "string",
  • "assetId": 0,
  • "batchId": 0,
  • "resultsUrl": "string",
  • "taxonomyVersionId": "f634d1c1-68af-48e0-aefa-208f1bd4c0f0",
  • "metadata": { },
  • "dueInSeconds": 1,
  • "difficulty": 100,
  • "assetType": "external"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "NEW",
  • "assetUrl": "string",
  • "assetId": 0,
  • "batchId": 0,
  • "resultsUrl": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "taxonomyVersionId": "f634d1c1-68af-48e0-aefa-208f1bd4c0f0",
  • "metadata": { },
  • "dueInSeconds": 1,
  • "difficulty": 100,
  • "assetType": "external"
}

List and filter work items under a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

query Parameters
cursor
string

Cursor for pagination

page
string (KeysetPaginationDirection)
Enum: "NEXT" "PREV"

Direction to paginate

limit
integer [ 1 .. 100 ]
Default: 20

Max number of items to return

workItemIDs
Array of strings <uuid> [ items <uuid > ]

Filter by a list of work item IDs (comma-separated or repeated keys)

batchIds
Array of integers <int64> <= 100 items [ items <int64 > ]

Filter by batch IDs (max 100)

status
string
Enum: "NEW" "IN_PROGRESS" "COMPLETED" "FAILED" "CANCELED" "CLIENT_REVIEW"

Filter by work item status

createdAtFrom
string <date-time>

Filter work items created on or after this timestamp (ISO 8601)

createdAtTo
string <date-time>

Filter work items created on or before this timestamp (ISO 8601)

updatedAtFrom
string <date-time>

Filter work items updated on or after this timestamp (ISO 8601)

updatedAtTo
string <date-time>

Filter work items updated on or before this timestamp (ISO 8601)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Insert ground truth labels for this work item

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

Request Body schema: application/json
required
required
Array of objects (WorkItemLabelsItemBase)

Responses

Request samples

Content type
application/json
{
  • "labels": [
    ]
}

Get annotation for a work item

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

query Parameters
format
string
Value: "coco"

Format of the annotation data

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectID": "4a3bdc18-db9e-4363-964a-de75946969f0",
  • "workItemID": "175a9be5-8190-45b1-b805-d597c128abe0",
  • "inference": { },
  • "groundTruthReviewer": "CONSENSUS_REVIEW",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Update signals for a work item

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

Request Body schema: application/json
required
One of
signal
required
string
Enum: "start" "release" "complete" "cancel" "reopen"

Signal used for task assignment and workflow management.

taskType
required
string

Type of the task for which signals are being updated, e.g. "labeling", "review", "external_review", etc. This is used for validating the task with the appropriate signals.

assignee
string

Optional assignee identifier (e.g. worker's email) for the work item when applicable.

signalOutcome
required
string (WorkItemSignalOutcome)
Enum: "OK" "NOT_OK"

Outcome reported for a completed signal.

object (WorkItemSignalItemFeedback)
reason
string or null

Optional reason or comments for the signal update, such as why a task was canceled or any relevant notes for the workflow.

Responses

Request samples

Content type
application/json
{
  • "signal": "start",
  • "taskType": "string",
  • "assignee": "string",
  • "signalOutcome": "OK",
  • "feedback": {
    },
  • "reason": "string"
}