List ML backends

GET

http://localhost:8000/api/ml/

List all configured ML backends for a specific project by ID. Use the following cURL command: ```bash curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'

List ML backends

GET

http://localhost:8000/api/ml/

List all configured ML backends for a specific project by ID. Use the following cURL command:

$ curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'

List all configured ML backends for a specific project by ID. Use the following cURL command: ```bash curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

projectintegerOptional

Project ID

Response

basic_auth_pass_is_setbooleanRead-only

created_atdatetimeRead-only

idintegerRead-only

projectinteger

readable_statestringRead-only

updated_atdatetimeRead-only

urlstring

URL for the machine learning model server

auth_methodenum

NONE - None
BASIC_AUTH - Basic Auth

Allowed values:

auto_updateboolean

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

basic_auth_userstring or null

HTTP Basic Auth user

descriptionstring or null

Description for the machine learning backend

error_messagestring or null

Error message in error state

extra_paramsany or null

Any extra parameters passed to the ML Backend during the setup

is_interactiveboolean

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

model_versionstring or null

Current model version associated with this machine learning backend

stateenum

CO - Connected
DI - Disconnected
ER - Error
TR - Training
PR - Predicting

Allowed values:

timeoutdouble

Response model timeout

titlestring or null

Name of the machine learning backend

1	[
2	{
3	"basic_auth_pass_is_set": true,
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": 42,
6	"project": 1,
7	"readable_state": "Connected",
8	"updated_at": "2024-04-10T12:00:00Z",
9	"url": "http://ml-backend.example.com/api/v1/predict",
10	"auth_method": "BASIC_AUTH",
11	"auto_update": true,
12	"basic_auth_user": "ml_user",
13	"description": "Image classification backend for project 1",
14	"error_message": null,
15	"extra_params": null,
16	"is_interactive": false,
17	"model_version": "v2.3.1",
18	"state": "CO",
19	"timeout": 5,
20	"title": "Image Classifier"
21	}
22	]

1	[
2	{
3	"basic_auth_pass_is_set": true,
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": 42,
6	"project": 1,
7	"readable_state": "Connected",
8	"updated_at": "2024-04-10T12:00:00Z",
9	"url": "http://ml-backend.example.com/api/v1/predict",
10	"auth_method": "BASIC_AUTH",
11	"auto_update": true,
12	"basic_auth_user": "ml_user",
13	"description": "Image classification backend for project 1",
14	"error_message": null,
15	"extra_params": null,
16	"is_interactive": false,
17	"model_version": "v2.3.1",
18	"state": "CO",
19	"timeout": 5,
20	"title": "Image Classifier"
21	}
22	]

$	curl http://localhost:8000/api/ml/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json"