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": [
    ]
}

Asset

List and filter assets in a space

Return a paginated list of assets in the space. Combined with the scheduled mounted-bucket sync, this lets a client look up the platform asset IDs for files it did not create through the API: sync ingests the bucket, this endpoint resolves bucket paths to asset IDs (via the paths filter), and those IDs are then used to create work items.

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

paths
Array of strings <= 100 items

Filter assets by their source bucket path (comma-separated or repeated keys, max 100). Paths are matched exactly after normalisation (a leading slash and the space bucket prefix are stripped). Paths with no matching asset are omitted from the result; the request still returns 200. Cannot be combined with pathPrefix (returns 400 if both are supplied).

pathPrefix
string

Filter assets whose source bucket path starts with this prefix (folder lookup). Normalised the same way as paths (a leading slash and the space bucket prefix are stripped). For example GB/ returns every asset under the GB/ folder. Cannot be combined with paths (returns 400 if both are supplied).

datasetId
integer <int64> >= 0

Filter assets to those belonging to this dataset.

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": [
    ]
}

Create an asset in a space

Create an asset in a space and return its identifier.

Spaces with a mounted bucket. When the space has a bucket mounted, path must reference an existing object in that mounted bucket; no data is copied into platform storage. The path is the object key relative to the mount's configured prefix. Path variants that differ only by a leading slash, an included mount prefix, or URL-encoding (e.g. %20 for spaces) resolve to the same object. Calling this endpoint again with the same object, space and datasetId returns the existing asset instead of creating a duplicate — regardless of whether the original asset was created via this API, a UI import, or a scheduled sync. supportingFiles paths are resolved the same way.

Spaces without a mounted bucket. path is either an https:// URL or a platform storage object obtained from the upload-URL endpoints.

Use the returned id as assetId when creating a work item via POST /v1/projects/{projectID}/workItems.

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

Request Body schema: application/json
datasetId
required
integer or null <int64> >= 0

Identifier of the dataset to which the asset will belong.

path
required
string

Path of the asset. For a space with a mounted bucket, this is the object key of an existing object in that bucket, relative to the mount's configured prefix (leading slash, included mount prefix and URL-encoding variants all resolve to the same object). For a space without a mounted bucket, this is an https:// URL or a platform storage object path from the upload-URL endpoints.

name
required
string

Name of the asset to be uploaded.

schemaType
string (AssetSchemaType)
Enum: "trace" "mcq" "span_labelling"

Optional schema classification. Trace assets must be standard OTLP/HTTP JSON containing OpenTelemetry GenAI spans. Span labelling assets are JSON-transport text used for span annotation.

Array of objects (CreateSupportingFile) <= 20 items

Supporting files for the asset (max 20). For a mounted-bucket space each path is resolved to an object in the mounted bucket the same way as the primary path.

Responses

Request samples

Content type
application/json
{
  • "datasetId": 0,
  • "path": "string",
  • "name": "string",
  • "schemaType": "trace",
  • "supportingFiles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "datasetId": 0,
  • "spaceId": "a330a273-e64a-4183-aedb-f3152797a9a5",
  • "url": "string",
  • "name": "string",
  • "mimeType": "string",
  • "supportingFiles": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sourceBucketPath": "string"
}

Get metadata values for an asset

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

assetID
required
integer <int64> >= 0

Unique identifier for the asset.

Responses

Response samples

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

Start a bulk CSV/XLSX or span labelling JSON asset import

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

Request Body schema: multipart/form-data
required
file
required
string <binary>

CSV/XLSX file to import, or a JSON file for span_labelling. See documentation for column format.

name
string

Optional human-readable name for this import job.

config
string

Optional JSON configuration payload for structured import mapping.

datasetId
string

Optional target dataset ID. When set, every imported asset is created under this dataset regardless of any per-row dataset_id column in the CSV or dataset mappings in the structured-import config payload. Returns 400 if the dataset does not exist in the space.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "PENDING",
  • "result": {
    },
  • "csvPath": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "downloadUrl": "string",
  • "error": "string"
}

Get the status and result of an asset import job

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

importJobID
required
string

Unique identifier for the asset import job.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "PENDING",
  • "result": {
    },
  • "csvPath": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "downloadUrl": "string",
  • "error": "string"
}

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)

active
boolean

Optional activation state override for the created batch

Responses

Request samples

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

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,
  • "active": true
}

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": [
    ]
}

Upsert activation state for batches in a project

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

Request Body schema: application/json
required
active_ids
Array of integers <int64> [ items <int64 > ]

Batch IDs to mark active

inactive_ids
Array of integers <int64> [ items <int64 > ]

Batch IDs to mark inactive

Responses

Request samples

Content type
application/json
{
  • "active_ids": [
    ],
  • "inactive_ids": [
    ]
}

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,
  • "active": true
}

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)

format
string (ExportFormat)
Enum: "COCO_JSON" "JSON" "CSV"

Filter by export format (e.g., COCO_JSON, JSON, CSV)

Responses

Response samples

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

Create an export

Starts an async export as a zip file. Supports COCO_JSON (annotation data, the default), or CSV/JSON with a selectable content: ANNOTATION (default) for annotation output, or ASSET_METADATA for each work item's related asset ID and structured metadata. 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)
Enum: "COCO_JSON" "JSON" "CSV"

Format of the exported data

content
string (ExportContent)
Default: "ANNOTATION"
Enum: "ANNOTATION" "ASSET_METADATA" "INFERENCE"

Content to include in the export. ANNOTATION (default) exports finalized annotations of completed work items. INFERENCE exports raw inferences (a work item may have several). ASSET_METADATA exports asset metadata. INFERENCE and ASSET_METADATA are only supported with the CSV and JSON formats (not COCO_JSON).

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",
  • "content": "ANNOTATION",
  • "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",
  • "content": "ANNOTATION",
  • "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",
  • "content": "ANNOTATION",
  • "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

Forms

List all forms for a project (metadata only)

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

Responses

Response samples

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

Get a form (including its current version)

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

formID
required
string <uuid>

Unique identifier for the form

query Parameters
expandRefs
boolean

Expand referenced taxonomy schemas in the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "formVersion": {
    }
}

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"
}

Public

Get JSON Web Key Set for webhook signature verification

Returns the public keys used to sign webhook payloads. Clients should use these keys to verify the X-Payload-Signature header on webhook callbacks. This endpoint is unauthenticated and publicly accessible.

Responses

Response samples

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

Webhooks

Get JSON Web Key Set for webhook signature verification

Returns the public keys used to sign webhook payloads. Clients should use these keys to verify the X-Payload-Signature header on webhook callbacks. This endpoint is unauthenticated and publicly accessible.

Responses

Response samples

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

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

Create a work item. To receive signed webhook callbacks for this item, set metadata.callbackUrl to your HTTPS endpoint. See the webhook callback integration guide.

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

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

Full URL to the asset. Required when creating with asset URL instead of assetId.

assetId
integer or null <int64> >= 0

Unique identifier for the asset associated with the work item. Required when creating with assetId instead of assetUrl.

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

Arbitrary key-value metadata stored with the work item.

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.

externalId
string

Optional external identifier for the work item, useful for idempotency and integration with external systems.

assetType
required
string (WorkItemAssetTypeEnum)
Enum: "image" "video" "pdf" "json"

Asset type for work items.

Array of objects (WorkItemLabelsItemBase)
labelsUrl
string

Storage-relative path to the labels file (e.g., "coco_output/abc123"). Not a full URL — the system prepends the space prefix internally.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "PENDING",
  • "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": 0,
  • "externalId": "string",
  • "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> <= 100 items [ 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 (WorkItemStatusEnum)
Enum: "PENDING" "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)

externalIDs
Array of strings <= 100 items

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

Responses

Response samples

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

Delete a work item (PENDING status only)

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

Responses

Response samples

Content type
application/json
{
  • "code": "INVALID_REQUEST",
  • "message": "string",
  • "request_id": "string"
}

List work item inferences

List the work item's data together with metadata for every inference recorded against it across stages (AI, labeling, review, QC) - including the identity (email) of each inference's generator - and per-stage (task) event timestamps. Each inference item omits the raw inference/label payload; use GET .../inferences/{inferenceID} to fetch a single inference's full payload.

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

Responses

Response samples

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

Get inference by ID

Get a single inference recorded against a work item, including its raw inference/label payload and the identity (email) of its generator.

Authorizations:
ApiKeyAuth
path Parameters
projectID
required
string <uuid>

Unique identifier for the project

workItemID
required
string <uuid>

Unique identifier for the work item

inferenceID
required
string <uuid>

Unique identifier for the inference

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "UNKNOWN",
  • "inference": { },
  • "userEmail": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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 (ExportFormatEnum)
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 subset for completion transition.

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

Feedback details with comments and optional frame-level feedback. Required for external_review complete signals with NOT_OK outcome.

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"
}

Taxonomies

List all taxonomies for a space (metadata only)

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

Responses

Response samples

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

Get a taxonomy (including its current version)

Authorizations:
ApiKeyAuth
path Parameters
spaceID
required
string <uuid>

Unique identifier for the space

taxonomyID
required
string <uuid>

Unique identifier for the taxonomy

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "taxonomyVersion": {
    }
}