Update ML Backend | API Reference

Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command:

$ curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\
> --data '{"url": "http://localhost:9091"}'

Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command: ```bash curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\ --data '{"url": "http://localhost:9091"}'

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

auth_methodenumOptional

Auth method

Allowed values:

basic_auth_passstringOptional

Basic auth password

basic_auth_userstringOptional

Basic auth user

descriptionstringOptional

Description

extra_paramsmap from strings to anyOptional

Extra parameters

is_interactivebooleanOptional

Is interactive

projectintegerOptional

Project ID

timeoutintegerOptional

Response model timeout

titlestringOptional

Title

urlstringOptional

ML backend URL

Response

basic_auth_pass_is_setstring

created_atdatetime

idinteger

projectinteger

readable_statestring

updated_atdatetime

urlstring

URL for the machine learning model server

auth_methodenum or null

NONE - None
BASIC_AUTH - Basic Auth

Allowed values:

auto_updateboolean or null

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

is_interactiveboolean or null

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 or null

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

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

Allowed values:

timeoutdouble or null

Response model timeout

titlestring or null

Name of the machine learning backend

1	curl -X PATCH http://localhost:8000/api/ml/1 \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"basic_auth_pass_is_set": "basic_auth_pass_is_set",
3	"created_at": "2024-01-15T09:30:00Z",
4	"id": 1,
5	"project": 1,
6	"readable_state": "readable_state",
7	"updated_at": "2024-01-15T09:30:00Z",
8	"url": "url",
9	"auth_method": "NONE",
10	"auto_update": true,
11	"basic_auth_user": "basic_auth_user",
12	"description": "description",
13	"error_message": "error_message",
14	"extra_params": {
15	"key": "value"
16	},
17	"is_interactive": true,
18	"model_version": "model_version",
19	"state": "CO",
20	"timeout": 1.1,
21	"title": "title"
22	}

$	curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\
>	--data '{"url": "http://localhost:9091"}'