ML

List ML backends

GET

List all configured Machine Learning (ML) backends for a specific project by ID. For more information about ML backends, see Machine learning integration.

You will need to provide the project ID. This can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

Query parameters

projectintegerOptional
Project ID

Response

This endpoint returns a list of objects
url
string
URL for the machine learning model server
project
integer
id
integerOptional
state
enumOptional
Allowed values: CODIERTRPR
readable_state
stringOptional
is_interactive
booleanOptional
Used to interactively annotate tasks. If true, model returns one list with results
error_message
stringOptional
Error message in error state
title
stringOptional
Name of the machine learning backend
auth_method
enumOptional
Allowed values: NONEBASIC_AUTH
basic_auth_user
stringOptional
HTTP Basic Auth user
basic_auth_pass
stringOptional
basic_auth_pass_is_set
stringOptional
description
stringOptional
Description for the machine learning backend
extra_params
map from strings to anyOptional
Any extra parameters passed to the ML Backend during the setup
model_version
stringOptional
Current model version associated with this machine learning backend
timeout
doubleOptional
Response model timeout
created_at
datetimeOptional
updated_at
datetimeOptional
auto_update
booleanOptional
If false, model version is set by the user, if true - getting latest version from backend.
GET
1curl http://localhost:8080/api/ml/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1[
2 {
3 "url": "url",
4 "project": 1,
5 "id": 1,
6 "state": "CO",
7 "readable_state": "readable_state",
8 "is_interactive": true,
9 "error_message": "error_message",
10 "title": "title",
11 "auth_method": "NONE",
12 "basic_auth_user": "basic_auth_user",
13 "basic_auth_pass": "basic_auth_pass",
14 "basic_auth_pass_is_set": "basic_auth_pass_is_set",
15 "description": "description",
16 "extra_params": {
17 "extra_params": {
18 "key": "value"
19 }
20 },
21 "model_version": "model_version",
22 "timeout": 1.1,
23 "created_at": "2024-01-15T09:30:00Z",
24 "updated_at": "2024-01-15T09:30:00Z",
25 "auto_update": true
26 }
27]