API docs by Redocly

Hasty API v1 (1.1)

Download OpenAPI specification:

Version 1 of our public API

Active Learning

Return the list of active learning heuristics available for each supported model family

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Triggers active learning ranking job to run with the given parameters

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
heuristic_id
string <uuid>

Active learning heuristic to use for ranking

model_family
string
Enum: "segmentor" "detector" "semantic-segmentor"

Model family to use for ranking

num_images
number

Number of images to rank

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

Dataset IDs for datasets to use in ranking

session_name
string

Name given to the ranking session

Responses

Request samples

Content type
application/json
{
  • "heuristic_id": "b8951afb-689e-443a-bdec-63d091f79391",
  • "model_family": "segmentor",
  • "num_images": 100,
  • "dataset_ids": [
    ],
  • "session_name": "My ranking session"
}

Response samples

Content type
application/json
{
  • "session_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "heuristic_id": "b8951afb-689e-443a-bdec-63d091f79391",
  • "model_family": "segmentor",
  • "status": "INIT",
  • "heuristic_name": "string",
  • "session_name": "My ranking session"
}

Attribute

Fetch existing attributes

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Add new attribute

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Request Body schema: application/json
required
is_required
boolean

Is attribute required

name
required
string

Attribute name

type
required
string
Enum: "SELECTION" "MULTIPLE-SELECTION" "TEXT" "INT" "FLOAT" "BOOL"

Attribute type

subject_type
string
Enum: "IMAGE" "VIDEO" "LABEL" "SEGMENT"

Subject type (default - LABEL)

default
string or null

Default value

description
string or null

Attribute description

min
number or null

Min value for int and float type

max
number or null

Max value for int and float type

norder
number

Attribute ordering

prediction_type
string or null
Enum: "llm" "ocr"

Which engine should be used for prediction

prediction_model
string or null
Enum: "gemini-2.0-flash" "gemini-2.0-flash-lite"

Model name for prediction

prediction_prompt
string or null

Prompt for prediction

required
Array of objects (AttributeLOV)

List of possible values for attributes of type SELECTION or MULTIPLE-SELECTION

Responses

Request samples

Content type
application/json
{
  • "is_required": false,
  • "name": "Color",
  • "type": "MULTIPLE-SELECTION",
  • "subject_type": "SEGMENT",
  • "default": "string",
  • "description": "Color of the label",
  • "min": 0,
  • "max": 0,
  • "norder": 0,
  • "prediction_type": "llm",
  • "prediction_model": "gemini-2.0-flash",
  • "prediction_prompt": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_required": false,
  • "name": "Color",
  • "type": "MULTIPLE-SELECTION",
  • "subject_type": "SEGMENT",
  • "default": "string",
  • "description": "Color of the label",
  • "min": 0,
  • "max": 0,
  • "norder": 0,
  • "class_count": 0,
  • "prediction_type": "llm",
  • "prediction_model": "gemini-2.0-flash",
  • "prediction_prompt": "string",
  • "values": [
    ]
}

Edit an existing attribute

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

attribute_id
required
string <uuid>
Example: a128136f-670e-41d6-8329-cb8d9608d7af

Attribute ID

Request Body schema: application/json
required
is_required
boolean

Is attribute required

name
required
string

Attribute name

type
required
string
Enum: "SELECTION" "MULTIPLE-SELECTION" "TEXT" "INT" "FLOAT" "BOOL"

Attribute type

subject_type
string
Enum: "IMAGE" "VIDEO" "LABEL" "SEGMENT"

Subject type (default - LABEL)

default
string or null

Default value

description
string or null

Attribute description

min
number or null

Min value for int and float type

max
number or null

Max value for int and float type

norder
number

Attribute ordering

prediction_type
string or null
Enum: "llm" "ocr"

Which engine should be used for prediction

prediction_model
string or null
Enum: "gemini-2.0-flash" "gemini-2.0-flash-lite"

Model name for prediction

prediction_prompt
string or null

Prompt for prediction

required
Array of objects (AttributeLOV)

List of possible values for attributes of type SELECTION or MULTIPLE-SELECTION

Responses

Request samples

Content type
application/json
{
  • "is_required": false,
  • "name": "Color",
  • "type": "MULTIPLE-SELECTION",
  • "subject_type": "SEGMENT",
  • "default": "string",
  • "description": "Color of the label",
  • "min": 0,
  • "max": 0,
  • "norder": 0,
  • "prediction_type": "llm",
  • "prediction_model": "gemini-2.0-flash",
  • "prediction_prompt": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_required": false,
  • "name": "Color",
  • "type": "MULTIPLE-SELECTION",
  • "subject_type": "SEGMENT",
  • "default": "string",
  • "description": "Color of the label",
  • "min": 0,
  • "max": 0,
  • "norder": 0,
  • "class_count": 0,
  • "prediction_type": "llm",
  • "prediction_model": "gemini-2.0-flash",
  • "prediction_prompt": "string",
  • "values": [
    ]
}

Delete an existing attribute

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

attribute_id
required
string <uuid>
Example: a128136f-670e-41d6-8329-cb8d9608d7af

Attribute ID

Responses

Fetch all label attributes for image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Bulk set of attributes for image labels

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array (non-empty)
id
required
string <uuid>

Attribute Identifier

label_id
required
string <uuid>

Label Identifier

required
(string or null) or (number or null) or (boolean or null) or (Array of strings or null)

Value of the attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Returns the list of attributes that are common for every label

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
[
  • {
    }
]

Return the list of classes assigned to attribute

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign list of classes to attribute

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
Array
attribute_id
required
string

Attribute ID

class_id
required
string

Label class ID

attribute_order
required
number

Order of attributes within the class

class_order
required
number

Order of classes within the attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Removes label classes from the attributes

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
Array
attribute_id
required
string

Attribute ID

class_id
required
string

Label class ID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Automated labeling

Get list of all automated labeling jobs for the project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Triggers the automated labeling job with the given Experiment ID

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
experiment_id
required
string <uuid>

Model Playground experiment that should be used for automated labeling

confidence_threshold
number <float>
Default: 0.8

Confidence threshold to run the automated labeling model on

max_detections_per_image
integer
Default: 100

Maximum number of detections

num_images
integer
Default: 0

Number of images to process

masker_threshold
number
Default: 0.5

Threshold for mask confidence

min_size
number
Default: 0

Min size in pixels of the object

dataset_id
string

Desired dataset to run automated labeling on

Responses

Request samples

Content type
application/json
{
  • "experiment_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "confidence_threshold": 0.8,
  • "max_detections_per_image": 100,
  • "num_images": 0,
  • "masker_threshold": 0.5,
  • "min_size": 100,
  • "dataset_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "project_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "status": "DONE",
  • "progress": 0.1,
  • "started_on": "string",
  • "completed_on": "string",
  • "images_processed": 1,
  • "experiment_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "user_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "confidence_threshold": 0.8,
  • "max_detections_per_image": 0,
  • "num_images": 0,
  • "masker_threshold": 0.5,
  • "min_size": 100,
  • "update_no_predictions": false,
  • "run_name": "My Finish Him Run"
}

Fetch dataset by job id

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

job_id
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "project_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "status": "DONE",
  • "progress": 0.1,
  • "started_on": "string",
  • "completed_on": "string",
  • "images_processed": 1,
  • "experiment_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "user_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "confidence_threshold": 0.8,
  • "max_detections_per_image": 0,
  • "num_images": 0,
  • "masker_threshold": 0.5,
  • "min_size": 100,
  • "update_no_predictions": false,
  • "run_name": "My Finish Him Run"
}

Dataset

Fetch existing datasets

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

name
string

Filter datasets which contain name (case-insensitive)

Responses

Response samples

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

Create a new dataset

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Dataset unique name

norder
number or null

Sorting order

Responses

Request samples

Content type
application/json
{
  • "name": "train",
  • "norder": 0
}

Response samples

Content type
application/json
{
  • "id": "e34f765f-cfd9-4789-a575-e083f35ac3f6",
  • "name": "train",
  • "norder": 0,
  • "project_id": "43b9cd34-7e2b-401e-9df2-6594d8893379"
}

Fetch dataset by id

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

dataset_id
required
string <uuid>

Dataset ID

Responses

Response samples

Content type
application/json
{
  • "id": "e34f765f-cfd9-4789-a575-e083f35ac3f6",
  • "name": "train",
  • "norder": 0,
  • "project_id": "43b9cd34-7e2b-401e-9df2-6594d8893379"
}

Delete an existing dataset

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

dataset_id
required
string <uuid>

Dataset ID

Responses

Edit an existing dataset

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

dataset_id
required
string <uuid>

Dataset ID

Request Body schema: application/json
required
name
required
string

Dataset unique name

norder
number or null

Sorting order

Responses

Request samples

Content type
application/json
{
  • "name": "train",
  • "norder": 0
}

Response samples

Content type
application/json
{
  • "id": "e34f765f-cfd9-4789-a575-e083f35ac3f6",
  • "name": "train",
  • "norder": 0,
  • "project_id": "43b9cd34-7e2b-401e-9df2-6594d8893379"
}

Uploads

Generate signed URLs for uploads.

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
count
required
integer [ 1 .. 50 ]
Example: count=1

The number of signed URLs to generate for upload

style
string
Enum: "simple" "resumable"
Example: style=resumable

Cloud uploads style

Responses

Response samples

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

Image

Fetch the list of images

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

dataset_id
Array of strings <uuid> [ items <uuid > ]
Example: dataset_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the dataset that the label belongs to

image_name
string
Example: image_name=img_001

Image name filter

image_status
Array of strings (DefaultStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "AUTO-LABELLED" "COMPLETED"

Status of the image

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

Status ID of media

Array of strings or strings

Tag class IDs

updated_since
integer

Filter for getting images updated since

created_since
integer

Filter for getting images created since

string or string

Queue ID

string or string

Batch ID

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

Error finder run IDs

ef_user_action
string (EFUserAction)
Enum: "ALL" "RESOLVED" "UNRESOLVED"

Error finder user action

ef_error_type
string (ErrorType)
Enum: "NOT_AN_ERROR" "LOW_IOU" "MISSING_LABEL" "EXTRA_LABEL" "MISCLASSIFICATION" "TAG_MISCLASSIFICATION" "ATTR_MISCLASSIFICATION" "EXTRA_TAG" "MISSING_TAG" "EXTRA_ATTRIBUTE" "MISSING_ATTRIBUTE" "EXTRA_AREA" "MISSING_AREA"
Example: ef_error_type=LOW_IOU

Error finder error type

aldi_session_id
string <uuid>

ALDI session ID

has_missing_attributes
boolean

Has missing required attributes

has_missing_tags
boolean

Missing required image tags

Responses

Response samples

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

Import image to project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
replace
boolean

Parameter to indicate that the image can be replaced if it exists already

Request Body schema: application/json
One of
dataset_id
required
string <uuid>

Dataset ID

upload_id
required
string <uuid>

Upload ID obtained for signed URL upload.

filename
required
string

Name of the file to be stored.

external_id
string or null

Stores an external ID, used for mapping.

Responses

Request samples

Content type
application/json
Example
{
  • "dataset_id": "e0144edc-c824-417c-bf1b-b3f66baa97d3",
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "filename": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "dataset_name": "string",
  • "height": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "format": "string",
  • "mode": "string",
  • "name": "string",
  • "health_status": "OK",
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "is_locked": true,
  • "public_url": "string",
  • "thumbnail_url": "string",
  • "uploaded_on": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
  • "url": "string",
  • "width": 0,
  • "external_id": "string",
  • "queue_ids": [
    ],
  • "exif": {
    }
}

Fetch image metadata

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Responses

Response samples

Content type
application/json
{
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "dataset_name": "string",
  • "height": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "format": "string",
  • "mode": "string",
  • "name": "string",
  • "health_status": "OK",
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "is_locked": true,
  • "public_url": "string",
  • "thumbnail_url": "string",
  • "uploaded_on": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
  • "url": "string",
  • "width": 0,
  • "external_id": "string",
  • "queue_ids": [
    ],
  • "exif": {
    }
}

Update an existing image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
One of
upload_id
required
string <uuid>

Upload ID obtained for signed URL upload.

filename
required
string

Name of the file to be stored

external_id
string or null

Stores an external ID, used for mapping.

Responses

Request samples

Content type
application/json
Example
{
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "filename": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "dataset_name": "string",
  • "height": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "format": "string",
  • "mode": "string",
  • "name": "string",
  • "health_status": "OK",
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "is_locked": true,
  • "public_url": "string",
  • "thumbnail_url": "string",
  • "uploaded_on": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
  • "url": "string",
  • "width": 0,
  • "external_id": "string",
  • "queue_ids": [
    ],
  • "exif": {
    }
}

Move or rename an existing image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
filename
string or null

Name of the file to be stored.

dataset_id
string or null <uuid>

Dataset ID to move to

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "dataset_id": "e0144edc-c824-417c-bf1b-b3f66baa97d3"
}

Response samples

Content type
application/json
{
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "dataset_name": "string",
  • "height": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "format": "string",
  • "mode": "string",
  • "name": "string",
  • "health_status": "OK",
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "is_locked": true,
  • "public_url": "string",
  • "thumbnail_url": "string",
  • "uploaded_on": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
  • "url": "string",
  • "width": 0,
  • "external_id": "string",
  • "queue_ids": [
    ],
  • "exif": {
    }
}

Deletes image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Responses

Update image status

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
One of
status
required
string (DefaultStatusWrite)
Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "COMPLETED"

Image status

Responses

Request samples

Content type
application/json
{
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c"
}

Returns offset for specific image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

query Parameters
dataset_id
Array of strings <uuid> [ items <uuid > ]
Example: dataset_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the dataset that the label belongs to

image_status
Array of strings (DefaultStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "AUTO-LABELLED" "COMPLETED"

Status of the image

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

Status ID of media

image_name
string
Example: image_name=img_001

Image name filter

Array of strings or strings

Tag class IDs

updated_since
integer

Filter for getting images updated since

created_since
integer

Filter for getting images created since

string or string

Queue ID

string or string

Batch ID

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

Error finder run IDs

ef_user_action
string (EFUserAction)
Enum: "ALL" "RESOLVED" "UNRESOLVED"

Error finder user action

ef_error_type
string (ErrorType)
Enum: "NOT_AN_ERROR" "LOW_IOU" "MISSING_LABEL" "EXTRA_LABEL" "MISCLASSIFICATION" "TAG_MISCLASSIFICATION" "ATTR_MISCLASSIFICATION" "EXTRA_TAG" "MISSING_TAG" "EXTRA_ATTRIBUTE" "MISSING_ATTRIBUTE" "EXTRA_AREA" "MISSING_AREA"
Example: ef_error_type=LOW_IOU

Error finder error type

aldi_session_id
string <uuid>

ALDI session ID

has_missing_attributes
boolean

Has missing required attributes

has_missing_tags
boolean

Missing required image tags

Responses

Response samples

Content type
application/json
{
  • "offset": 120
}

Keypoint

Returns the list of keypoint schemas for a project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new keypoint schema

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Name of the keypoint schema

project_id
string <uuid>

Project ID

description
string or null

Description of the keypoint schema

type
required
string
Enum: "pose" "points" "polyline"

Keypoint schema type

norder
number or null

Sorting order

Array of objects or null (KeypointClass)

List of keypoint classes for this keypoint schema

Array of objects or null (KeypointSkeleton)
template_id
string or null <uuid>

Keypoint schema template ID

Responses

Request samples

Content type
application/json
{
  • "name": "Person",
  • "project_id": "a8e7a6c4-8bbb-4ea3-b70f-02cddd456fc7",
  • "description": "A person playing sports",
  • "type": "pose",
  • "norder": 0,
  • "keypoint_classes": [
    ],
  • "keypoint_skeleton": [
    ],
  • "template_id": "d146908c-fdd8-4fc8-a007-9073f072a007"
}

Response samples

Content type
application/json
{
  • "id": "7fed7ec5-675a-4287-9ca2-4cfe6a6c422c",
  • "name": "Person",
  • "project_id": "a8e7a6c4-8bbb-4ea3-b70f-02cddd456fc7",
  • "description": "A person playing sports",
  • "type": "pose",
  • "created_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "create_date": "2019-08-24T14:15:22Z",
  • "updated_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "update_date": "2019-08-24T14:15:22Z",
  • "norder": 0,
  • "keypoint_classes": [
    ],
  • "keypoint_skeleton": [
    ],
  • "template_id": "d146908c-fdd8-4fc8-a007-9073f072a007"
}

Updates a keypoint schema

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

keypoint_schema_id
required
string <uuid>
Example: eae3bc2a-0205-462c-a992-abf2e38e5138

Keypoint Schema ID

Request Body schema: application/json
required
name
required
string

Name of the keypoint schema

project_id
string <uuid>

Project ID

description
string or null

Description of the keypoint schema

type
required
string
Enum: "pose" "points" "polyline"

Keypoint schema type

norder
number or null

Sorting order

Array of objects or null (KeypointClass)

List of keypoint classes for this keypoint schema

Array of objects or null (KeypointSkeleton)
template_id
string or null <uuid>

Keypoint schema template ID

Responses

Request samples

Content type
application/json
{
  • "name": "Person",
  • "project_id": "a8e7a6c4-8bbb-4ea3-b70f-02cddd456fc7",
  • "description": "A person playing sports",
  • "type": "pose",
  • "norder": 0,
  • "keypoint_classes": [
    ],
  • "keypoint_skeleton": [
    ],
  • "template_id": "d146908c-fdd8-4fc8-a007-9073f072a007"
}

Response samples

Content type
application/json
{
  • "id": "7fed7ec5-675a-4287-9ca2-4cfe6a6c422c",
  • "name": "Person",
  • "project_id": "a8e7a6c4-8bbb-4ea3-b70f-02cddd456fc7",
  • "description": "A person playing sports",
  • "type": "pose",
  • "created_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "create_date": "2019-08-24T14:15:22Z",
  • "updated_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "update_date": "2019-08-24T14:15:22Z",
  • "norder": 0,
  • "keypoint_classes": [
    ],
  • "keypoint_skeleton": [
    ],
  • "template_id": "d146908c-fdd8-4fc8-a007-9073f072a007"
}

Delete a keypoint schema

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

keypoint_schema_id
required
string <uuid>
Example: eae3bc2a-0205-462c-a992-abf2e38e5138

Keypoint Schema ID

Responses

Returns the mapping between keypoint schemas and label classes for a project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the mapping between keypoint schemas and label classes for a project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
Array
keypoint_schema_id
required
string <uuid>

Keypoint schema ID

label_class_id
string <uuid>

Label class ID

label_class_order
required
number

Order of label class within the keypoint schema

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Delete mapping between keypoint schemas and label classes

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
Array
keypoint_schema_id
required
string <uuid>

Keypoint schema ID

label_class_id
string <uuid>

Label class ID

label_class_order
required
number

Order of label class within the keypoint schema

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Label

Fetch labels for project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

label_class_id
string <uuid>
Example: label_class_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Label class ID

labeler_id
string <uuid>
Example: labeler_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the user that modified a label last

dataset_id
Array of strings <uuid> [ items <uuid > ]
Example: dataset_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the dataset that the label belongs to

image_status
Array of strings (DefaultStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "AUTO-LABELLED" "COMPLETED"

Status of the image

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

Status ID of media

image_name
string
Example: image_name=img_001

Image name filter

label_author_id
string <uuid>
Example: label_author_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the user that creates label

attribute_id
string <uuid>
Example: attribute_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the attribute to filter by (requries attrubute value)

attribute_value
string
Example: attribute_value=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the attribute value to filter by (requries attrubute id)

bool_attribute_value
boolean
Example: bool_attribute_value=true

Boolean filter for attributes of type BOOL

created_since
string
Example: created_since=30m

Datetime interval to filter labels by creation date (1h, 30m, 3d etc)

updated_since
string
Example: updated_since=30m

Datetime interval to filter labels by update date (1h, 30m, 3d etc)

no_attribute_id
string <uuid>
Example: no_attribute_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the attribute that are not specified for a label

keypoint_schema_id
string <uuid>
Example: keypoint_schema_id=eae3bc2a-0205-462c-a992-abf2e38e5138

ID of the keypoint schema to filter by

add_keypoint_data
boolean

Whether to aggregate and join keypoint class data per label.

Responses

Response samples

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

Fetch label metadata

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Label ID

query Parameters
include_border_mask
boolean
Example: include_border_mask=true

Boolean filter for calculete border mask

include_errors
boolean
Example: include_errors=true

Whether to return labels with errors

Responses

Response samples

Content type
application/json
{
  • "bbox": [
    ],
  • "class_id": "54be4e86-fa06-45fc-86e5-29ea93b4a062",
  • "created_on": "2019-08-24T14:15:22Z",
  • "external_event_id": "string",
  • "image_id": "84c230fd-5520-4984-8119-37365b66fd80",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mask": [
    ],
  • "polygon": [
    ],
  • "tool_used": "polygon",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "labeled_by": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "z_index": 0,
  • "border_mask": "string",
  • "external_id": "string",
  • "keypoints": [
    ],
  • "error": "string"
}

Fetch labels for the specified image

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

include_border_mask
boolean
Example: include_border_mask=true

Boolean filter for calculete border mask

include_errors
boolean
Example: include_errors=true

Whether to return labels with errors

Responses

Response samples

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

Create multiple labels in batch

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
bbox
Array of integers or null = 4 items

Bounding box coordinate [left, top, right, bottom]

class_id
string <uuid>

Label class

external_event_id
string or null

Event ID from frontend, if any.

mask
Array of integers or null >= 2 items

RLE encoded mask [pixel index, length, pixel index, length]

polygon
Array of integers or null non-empty [ items = 2 items ]

Polygon coordinates [[x0, y0], [x1, y1], ... ,[x0, y0]]

tool_used
string or null (ToolUsed)
Enum: "bbox" "polygon" "contour" "magic_wand" "brush" "grabcut" "dextr" "object_detection" "instance_segmentation" "semantic_segmentation" "import" "copy" "atom" "error_finder" "finish_him" "api" "duplicated" "box2mask" "keypoints" "text_to_mask" "keypoint_detection" "inference_monitor" "merge"

Tool that used to create label, possible values

z_index
integer or null

Label hierarchy level

border_mask
string or null

Calculated border mask by border and mask fields

external_id
string or null

External ID

Array of objects or null (LabelKeypoint)

List of keypoints

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Update multiple labels in batch

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
bbox
Array of integers or null = 4 items

Bounding box coordinate [left, top, right, bottom]

class_id
string <uuid>

Label class

external_event_id
string or null

Event ID from frontend, if any.

mask
Array of integers or null >= 2 items

RLE encoded mask [pixel index, length, pixel index, length]

polygon
Array of integers or null non-empty [ items = 2 items ]

Polygon coordinates [[x0, y0], [x1, y1], ... ,[x0, y0]]

tool_used
string or null (ToolUsed)
Enum: "bbox" "polygon" "contour" "magic_wand" "brush" "grabcut" "dextr" "object_detection" "instance_segmentation" "semantic_segmentation" "import" "copy" "atom" "error_finder" "finish_him" "api" "duplicated" "box2mask" "keypoints" "text_to_mask" "keypoint_detection" "inference_monitor" "merge"

Tool that used to create label, possible values

z_index
integer or null

Label hierarchy level

border_mask
string or null

Calculated border mask by border and mask fields

external_id
string or null

External ID

Array of objects or null (LabelKeypoint)

List of keypoints

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Delete multiple labels in batch

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
id
required
string <uuid>

ID of the object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Fetch label attributes and values

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Label ID

Responses

Response samples

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

Set attribute value for label

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Label ID

attribute_id
required
string <uuid>
Example: a128136f-670e-41d6-8329-cb8d9608d7af

Attribute ID

Request Body schema: application/json
required
required
(string or null) or (number or null) or (boolean or null) or (Array of strings or null)

Value of the attribute

string or Array of strings

Predicted value of the attribute

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "predicted_values": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
  • "name": "string",
  • "type": "MULTIPLE-SELECTION",
  • "description": "string",
  • "value": "string"
}

Label class

Fetch the list of label classes

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Add a new labeling class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Class name

description
string or null

Class description

type
string
Enum: "object" "background"

Class type object or background

color
string or null

Label color

icon_url
string or null

URL to class icon (for future usage)

norder
number or null

Label class order

parent_id
string or null <uuid>

Parent label (for future usage)

external_id
string or null

External ID (for API)

use_description_as_prompt
boolean or null

Flag to indicate if description should be used as text prompt

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "object",
  • "color": "string",
  • "icon_url": "string",
  • "norder": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "external_id": "string",
  • "use_description_as_prompt": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "object",
  • "color": "string",
  • "icon_url": "string",
  • "norder": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "external_id": "string",
  • "use_description_as_prompt": true
}

Fetch the label classes by id

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Label class ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "object",
  • "color": "string",
  • "icon_url": "string",
  • "norder": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "external_id": "string",
  • "use_description_as_prompt": true
}

Delete an existing label class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Label class ID

Responses

Edit an existing labeling class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

label_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Label class ID

Request Body schema: application/json
required
name
required
string

Class name

description
string or null

Class description

type
string
Enum: "object" "background"

Class type object or background

color
string or null

Label color

icon_url
string or null

URL to class icon (for future usage)

norder
number or null

Label class order

parent_id
string or null <uuid>

Parent label (for future usage)

external_id
string or null

External ID (for API)

use_description_as_prompt
boolean or null

Flag to indicate if description should be used as text prompt

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "object",
  • "color": "string",
  • "icon_url": "string",
  • "norder": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "external_id": "string",
  • "use_description_as_prompt": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "object",
  • "color": "string",
  • "icon_url": "string",
  • "norder": 0,
  • "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
  • "external_id": "string",
  • "use_description_as_prompt": true
}

Mounting buckets

Retrieve all stored buckets credentials for a given workspace

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

Responses

Response samples

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

Create a new set of credentials

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

Request Body schema: application/json
required
Any of
secret
string

Secret key

description
string

Any human-readable description for credentials

cloud_provider
string

Cloud provider

Responses

Request samples

Content type
application/json
Example
{
  • "secret": "string",
  • "description": "Autonomous car dashcam pictures",
  • "cloud_provider": "string"
}

Response samples

Content type
application/json
{
  • "credential_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "description": "Autonomous car dashcam pictures",
  • "cloud_provider": "s3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z"
}

Update bucket credentials information

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

bucket_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of bucket credentials set

Request Body schema: application/json
required
Any of
secret
string

Secret key

description
string

Any human-readable description for credentials

cloud_provider
string

Cloud provider

Responses

Request samples

Content type
application/json
Example
{
  • "secret": "string",
  • "description": "Autonomous car dashcam pictures",
  • "cloud_provider": "string"
}

Response samples

Content type
application/json
{
  • "credential_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "description": "Autonomous car dashcam pictures",
  • "cloud_provider": "s3",
  • "created_at": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z"
}

Delete bucket credentials information

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

bucket_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of bucket credentials set

Responses

Perform import bucket content

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

bucket_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of bucket credentials set

Request Body schema: application/json
required
dataset_id
required
string <uuid>

Dataset where the objects are going to be uploaded to

copy
boolean

Whether the bucket objects has to be copied to hasty or not

prefix
string

import path prefix

upload_id
string

Upload ID for the objects list TXT

upload_scope_id
string

Upload ID scope for the objects list TXT

asset_type
string
Enum: "images" "videos"

which kind of asset is being imported

Responses

Request samples

Content type
application/json
{
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "copy": true,
  • "prefix": "folder/subfolder/prefix",
  • "upload_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "upload_scope_id": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "asset_type": "images"
}

Perform a preview of the bucket content

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

bucket_id
required
string <uuid>
Example: 4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of bucket credentials set

query Parameters
prefix
string
Example: prefix=datasets/food/

import path prefix

upload_id
string
Example: upload_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Upload ID of the TXT file with list of objects

upload_scope_id
string
Example: upload_scope_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

Upload scope ID of the TXT file with list of objects

Responses

Response samples

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

Project

Create a new project

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
name
required
string

Project name

workspace_id
string or null <uuid>

Workspace identifier

description
string or null

Project description

content_type
string
Enum: "IMAGES" "VIDEOS" "URLDATA"

Content type (images or videos or URLs)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "description": "string",
  • "content_type": "IMAGES"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "last_opened_on": "2019-08-24T14:15:22Z",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "content_type": "IMAGES"
}

Fetch the list of projects

Authorizations:
ApiKeyAuth
query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

name
string

Filter projects which contain name (case-insensitive)

Responses

Response samples

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

Delete an existing project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Fetch existing project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "last_opened_on": "2019-08-24T14:15:22Z",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "content_type": "IMAGES"
}

Edit an existing project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Project name

workspace_id
string or null <uuid>

Workspace identifier

description
string or null

Project description

content_type
string
Enum: "IMAGES" "VIDEOS" "URLDATA"

Content type (images or videos or URLs)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "description": "string",
  • "content_type": "IMAGES"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "last_opened_on": "2019-08-24T14:15:22Z",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "description": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "content_type": "IMAGES"
}

Initiates project export

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
format
required
string
Enum: "json_v1.1" "semantic_png" "json_coco" "pascal" "images" "videos" "yolo"

Export format. Videos projects only support json_v1.1

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

List of dataset IDs to be filtered

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

List of tag class IDs to be filtered

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

List of label class IDs to be filtered

status_start_time
string or null <date-time>

Start time filter for status

video_status
Array of strings (DefaultStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "AUTO-LABELLED" "COMPLETED"

List of video statuses to be filtered. This is only in effect for video projects

image_status
Array of strings (DefaultStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "AUTO-LABELLED" "COMPLETED"

List of image statuses to be filtered. This is only in effect for image projects

sign_urls
boolean

Whether to add signed URLs for publicly accessing images/videos

export_name
string

Exported filename

semantic_format
string or null
Enum: "gs_asc" "gs_desc" "class_color"

Semantic pixel encoding format

labels_order
Array of strings or null
Enum: "z_index" "class_type" "class_order"

The order in which the labels should be drawn. Only applicable for images

Responses

Request samples

Content type
application/json
{
  • "format": "json_v1.1",
  • "dataset_id": [
    ],
  • "tag": [
    ],
  • "class": [
    ],
  • "status_start_time": "2019-08-24T14:15:22Z",
  • "video_status": [
    ],
  • "image_status": [
    ],
  • "sign_urls": true,
  • "export_name": "my_coco_export",
  • "semantic_format": "class_color",
  • "labels_order": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "COPY_PROJECT",
  • "status": "INIT",
  • "started_by": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "project_id": "9467ed7d-0cff-4ea3-aa1b-f6f2c17a71cb",
  • "started_on": "2019-08-24T14:15:22Z",
  • "completed_on": "2019-08-24T14:15:22Z",
  • "meta": { }
}

Fetch a job

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

export_id
required
string <uuid>
Example: 43b9cd34-7e2b-401e-9df2-6594d8893379

Export job ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "COPY_PROJECT",
  • "status": "INIT",
  • "started_by": "4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad",
  • "project_id": "9467ed7d-0cff-4ea3-aa1b-f6f2c17a71cb",
  • "started_on": "2019-08-24T14:15:22Z",
  • "completed_on": "2019-08-24T14:15:22Z",
  • "meta": { }
}

Tag

Fetch the list of image tags

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Add a new tags

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
tag_class_id
required
string <uuid>

Tag class ID

predicted
boolean

Whether the tag was predicted by the assistant or not

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing tags

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

image_id
required
string <uuid>

Image ID

Request Body schema: application/json
required
Array
tag_id
string or null <uuid>

Tag ID

tag_class_id
string or null <uuid>

Tag class ID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Tag class

Fetch the list of tag classes

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Add a new tag class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Tag name

norder
number or null

Tag class order

tag_group_id
string or null

Tag group ID

tag_group_name
string or null

Tag group name

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "norder": 0,
  • "tag_group_id": "string",
  • "tag_group_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "norder": 0,
  • "tag_group_id": "string",
  • "tag_group_name": "string"
}

Fetch the tag classes by id

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag class ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "norder": 0,
  • "tag_group_id": "string",
  • "tag_group_name": "string"
}

Delete an existing tag class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag class ID

Responses

Edit an existing tag class

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_class_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag class ID

Request Body schema: application/json
required
name
required
string

Tag name

norder
number or null

Tag class order

tag_group_id
string or null

Tag group ID

tag_group_name
string or null

Tag group name

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "norder": 0,
  • "tag_group_id": "string",
  • "tag_group_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "norder": 0,
  • "tag_group_id": "string",
  • "tag_group_name": "string"
}

Tag group

Fetch the list of tag groups

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Add a new tag group

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string

Tag group name

type
required
string
Enum: "SELECTION" "MULTIPLE-SELECTION"

Tag group type

is_required
boolean
Default: false

Tag group is required

norder
number

Tag groups order

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "SELECTION",
  • "is_required": false,
  • "norder": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "SELECTION",
  • "is_required": false,
  • "norder": 0
}

Fetch the tag group by id

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_group_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag group ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "SELECTION",
  • "is_required": false,
  • "norder": 0
}

Delete an existing tag group

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_group_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag group ID

Responses

Edit an existing tag group

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

tag_group_id
required
string <uuid>
Example: 3637334b-1584-4941-ba7d-7018635858b9

Tag group ID

Request Body schema: application/json
required
name
required
string

Tag group name

type
required
string
Enum: "SELECTION" "MULTIPLE-SELECTION"

Tag group type

is_required
boolean
Default: false

Tag group is required

norder
number

Tag groups order

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "SELECTION",
  • "is_required": false,
  • "norder": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "SELECTION",
  • "is_required": false,
  • "norder": 0
}

Video

Fetch the list of videos

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

dataset_id
Array of strings <uuid> [ items <uuid > ]
Example: dataset_id=4c9b159b-4b59-492e-a8f9-ca4c2c5cf3ad

ID of the dataset that the label belongs to

video_status
Array of strings (VideoStatus)
Items Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "COMPLETED" "[CUSTOM STATUS]"

Status of the video

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

Status ID of media

video_name
string
Example: video_name=vid_001

Video name filter

health_status
Array of strings
Items Enum: "OK" "ERROR" "UNHEALTHY" "PROCESSING"

Health status of the video

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

Video which has a segment of the given activity

string or string

Queue ID

string or string

Batch ID

Responses

Response samples

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

Import video to project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
One of
dataset_id
required
string <uuid>

Dataset ID

upload_id
required
string <uuid>

Upload ID obtained for signed URL upload.

filename
required
string

Name of the file to be stored.

Responses

Request samples

Content type
application/json
Example
{
  • "dataset_id": "e0144edc-c824-417c-bf1b-b3f66baa97d3",
  • "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "width": 0,
  • "height": 0,
  • "format": "string",
  • "frame_rate": 0,
  • "public_url": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "url": "string",
  • "duration_ms": 0,
  • "duration_frames": 0,
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "health_status": "string",
  • "dataset_name": "string",
  • "queue_ids": [
    ]
}

Fetch video metadata

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "width": 0,
  • "height": 0,
  • "format": "string",
  • "frame_rate": 0,
  • "public_url": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "url": "string",
  • "duration_ms": 0,
  • "duration_frames": 0,
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "health_status": "string",
  • "dataset_name": "string",
  • "queue_ids": [
    ]
}

Move or rename an existing video

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

Request Body schema: application/json
filename
string or null

Name of the file to be stored.

dataset_id
string or null <uuid>

Dataset ID to move to

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "dataset_id": "e0144edc-c824-417c-bf1b-b3f66baa97d3"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "width": 0,
  • "height": 0,
  • "format": "string",
  • "frame_rate": 0,
  • "public_url": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "url": "string",
  • "duration_ms": 0,
  • "duration_frames": 0,
  • "status": "NEW",
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  • "health_status": "string",
  • "dataset_name": "string",
  • "queue_ids": [
    ]
}

Deletes video

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

Responses

Set video status

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

Request Body schema: application/json
One of
status
required
string (DefaultStatusWrite)
Enum: "NEW" "IN PROGRESS" "TO REVIEW" "DONE" "SKIPPED" "COMPLETED"

Image status

Responses

Request samples

Content type
application/json
{
  • "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c"
}

Video Segments

Fetch the list of video segments

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

activity_type_id
string <uuid>

Actvity type ID

start_time_ms
integer

Filter by segment start (in milliseconds)

end_time_ms
integer

Filter by segment end (in milliseconds)

Responses

Response samples

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

Create a video segment

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

video_id
required
string <uuid>

Video ID

query Parameters
replace_overlap
boolean

Flag to replace overlapping segments when creating

Request Body schema: application/json
required
video_id
string <uuid>
start_time_ms
required
integer
end_time_ms
required
integer
activities
required
Array of strings <uuid> non-empty [ items <uuid > ]

List of assigned activities

prediction_id
string <uuid>

Unique identifier of the prediction used for this segment

Responses

Request samples

Content type
application/json
{
  • "video_id": "165252b3-cd77-4f41-a38f-02417eac7441",
  • "start_time_ms": 0,
  • "end_time_ms": 0,
  • "activities": [
    ],
  • "prediction_id": "89bf514f-6f07-41f8-bafc-8a53a08a04ae"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "video_id": "165252b3-cd77-4f41-a38f-02417eac7441",
  • "start_time_ms": 0,
  • "end_time_ms": 0,
  • "activities": [
    ],
  • "prediction_id": "89bf514f-6f07-41f8-bafc-8a53a08a04ae",
  • "created_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete an existing video segment

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

segment_id
required
string <uuid>

Segment ID

Responses

Edit an existing video segment

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

segment_id
required
string <uuid>

Segment ID

Request Body schema: application/json
required
video_id
string <uuid>
start_time_ms
required
integer
end_time_ms
required
integer
activities
required
Array of strings <uuid> non-empty [ items <uuid > ]

List of assigned activities

prediction_id
string <uuid>

Unique identifier of the prediction used for this segment

Responses

Request samples

Content type
application/json
{
  • "video_id": "165252b3-cd77-4f41-a38f-02417eac7441",
  • "start_time_ms": 0,
  • "end_time_ms": 0,
  • "activities": [
    ],
  • "prediction_id": "89bf514f-6f07-41f8-bafc-8a53a08a04ae"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "video_id": "165252b3-cd77-4f41-a38f-02417eac7441",
  • "start_time_ms": 0,
  • "end_time_ms": 0,
  • "activities": [
    ],
  • "prediction_id": "89bf514f-6f07-41f8-bafc-8a53a08a04ae",
  • "created_by": "cea1f108-4049-446e-819a-822e7b652049",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch the list of video actvity types

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Responses

Response samples

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

Create a video activity type

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

Request Body schema: application/json
required
name
required
string
color
string or null
prefix
string or null

Responses

Request samples

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

Response samples

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

Delete an existing video activity type

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

activity_type_id
required
string <uuid>

Activity type ID

Responses

Edit an existing video Activity Type

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Project ID

activity_type_id
required
string <uuid>

Activity type ID

Request Body schema: application/json
required
name
required
string
color
string or null
prefix
string or null

Responses

Request samples

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

Response samples

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

Workspace

Fetch the list of workspaces

Authorizations:
ApiKeyAuth
query Parameters
offset
integer >= 0

Offset for this paginated query

limit
integer >= 0
Example: limit=100

Limit for this paginated query

Responses

Response samples

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

Fetch an existing workspace

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

Responses

Response samples

Content type
application/json
{
  • "id": "92874094-a7b8-4cb9-bd33-8d8fc57f3137",
  • "name": "Hasty Workspace",
  • "unique_name": "hasty_workspace",
  • "description": "Some description",
  • "logo_url": "string",
  • "is_public": false,
  • "is_default": false,
  • "background_color": "string",
  • "subscription": "basic",
  • "parked_on": "2019-08-24T14:15:22Z",
  • "user_role": "Owner",
  • "allow_support": false,
  • "support_email": "string",
  • "feature_mounting_buckets": true
}

Edit workspace

Authorizations:
ApiKeyAuth
path Parameters
workspace_id
required
string <uuid>
Example: 17a4fab4-c59c-4031-9cb5-41fccb5b054c

Workspace ID

Request Body schema: application/json
required
name
required
string
unique_name
string or null
description
string or null
logo_url
string or null
is_public
boolean
background_color
string or null
allow_support
boolean
support_email
string or null

Some email for support

feature_mounting_buckets
boolean

Mounting buckets feature status

Responses

Request samples

Content type
application/json
{
  • "name": "Hasty Workspace",
  • "unique_name": "hasty_workspace",
  • "description": "Some description",
  • "logo_url": "string",
  • "is_public": false,
  • "background_color": "string",
  • "allow_support": false,
  • "support_email": "string",
  • "feature_mounting_buckets": true
}

Response samples

Content type
application/json
{
  • "id": "92874094-a7b8-4cb9-bd33-8d8fc57f3137",
  • "name": "Hasty Workspace",
  • "unique_name": "hasty_workspace",
  • "description": "Some description",
  • "logo_url": "string",
  • "is_public": false,
  • "is_default": false,
  • "background_color": "string",
  • "subscription": "basic",
  • "parked_on": "2019-08-24T14:15:22Z",
  • "user_role": "Owner",
  • "allow_support": false,
  • "support_email": "string",
  • "feature_mounting_buckets": true
}