response

A unique integer value identifying this annotation.

Get annotation by its ID

Delete annotation

Update an annotation

Get all task annotations

Create annotation

Annotations

Reset your access token or API key. When reset, any scripts or automations you have in place will need to be updated with the new key.

Reset user token

Get user token

Get information about your user account, such as your username, email, and user ID.

Retrieve my user

List all users in your Label Studio organization.

List users

Create a user

Get user info

Delete user

Update user details

Users

Retrieve all the registered actions with descriptions that data manager can use.

Get actions

View ID (optional, it has higher priority than filters, selectedItems and ordering from the request body payload)

Post actions

Actions

List views

Create view

Delete all project views

Get view details

Delete view

Update view

Views

A unique integer value identifying this file upload.

Get file upload

Delete file upload

Update file upload

Set to "true" if you want to retrieve all file uploads

Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3]

Get files list

Delete files

Download file

Files

Which field to use when ordering the results.

A page number within the paginated result set.

List all projects

Create new project

A unique integer value identifying this project.

Get project by ID

Delete project

Update a project

Set to "true" to immediately commit tasks to the project.

Set to "true" to return task IDs in the response.

Import tasks

Validate project labeling config

Easy export of tasks and annotations

Get export formats

List all export snapshots

Create new export snapshot

Get export snapshot by ID

Delete export snapshot

Export conversion

Download export snapshot

Exports

Projects

List ML backends

Add ML backend

A unique integer value identifying this ml backend.

Get ML backend

Remove ML backend

Update ML backend

A unique integer value identifying this ML backend.

Request interactive annotations

Start training

Get model versions

List predictions

Create prediction

Get prediction details

Delete prediction

Update prediction

Predictions

Get project import info

Delete all tasks

Resolve task data URIs using Cloud Storage

Set to "all" if you want to include annotations and predictions in the response

Specify which fields to include in the response

Get task list

Create task

Get task

Delete task

Update task

Tasks

Retrieve a list of the import storages types.

List all import storages types

List import storages

Create new storage

Validate a specific Azure import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Validate import storage

Get import storage

Delete import storage

Update import storage

Sync import storage

Azure

Create import storage

Validate a specific GCS import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Validate a specific local file import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Local

Validate a specific Redis import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Redis

Validate a specific S3 import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.

Import Storage

Retrieve a list of the export storages types.

List all export storages types

List export storages

Validate a specific Azure export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.

Validate export storage

Get export storage

Delete export storage

Update export storage

Sync export storage

Validate a specific GCS export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.

Validate a specific local file export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.

Validate a specific Redis export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.

Validate a specific S3 export storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to export data.

Export Storage

List all webhooks

Create a webhook

Get all webhook actions

A unique integer value identifying this webhook.

Get webhook info

Delete webhook

If value is False - used only for actions from WebhookAction

If value is False the webhook is disabled

Update webhook info

Webhooks

Annotation

How much time it took to annotate the task

Original annotation ID that was at the import step or NULL if this annotation wasn't imported

Action which was performed in the last annotation history item

Points to the prediction from which this annotation was created

Points to the parent annotation from which this annotation was created

User who created the last annotation history item

AnnotationFilterOptions

Include not skipped and not ground truth annotations

AnnotationLastAction

AnnotationsDmField

User details who completed this annotation.

AnnotationsDmFieldLastAction

AzureBlobExportStorage

Cloud storage regex for filtering objects

Interpret objects as BLOBs and generate URLs

Traceback report for the last failed sync

Meta and debug information about storage processes

AzureBlobExportStorageStatus

AzureBlobImportStorage

AzureBlobImportStorageStatus

BaseTask

User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.

Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.

Number of distinct annotators that processed the current task

Internal task ID in the project, starts with 1

Number of total annotations for the current task except cancelled annotations

Number of total cancelled annotations for the current task

Number of total predictions for the current task

Number of comments in the task including all annotations

Number of unresolved comments in the task including all annotations

Last annotator or reviewer who updated this task

Uploaded file used as data source for this task

BaseUser

ConvertedFormat

ConvertedFormatStatus

DataManagerTaskSerializer

DataManagerTaskSerializerDraftsItem

DataManagerTaskSerializerPredictionsItem

Export

ExportConvert

ExportCreate

ExportCreateStatus

ExportStatus

FileUpload

Filter

FilterGroup

GcsExportStorage

GcsExportStorageStatus

GcsImportStorage

GcsImportStorageStatus

LocalFilesExportStorage

LocalFilesExportStorageStatus

LocalFilesImportStorage

LocalFilesImportStorageStatus

MlBackend

Used to interactively annotate tasks. If true, model returns one list with results

URL for the machine learning model server

Description for the machine learning backend

Any extra parameters passed to the ML Backend during the setup

Current model version associated with this machine learning backend

If false, model version is set by the user, if true - getting latest version from backend.

MlBackendAuthMethod

MlBackendState

Prediction

Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface

Array of task IDs of the closest neighbors

1	curl -X DELETE http://localhost:8080/api/ml/1 \
2	-H "Authorization: Token <api_key>"

Remove ML backend

Path parameters