Sign in

v77

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-045764591.5 MB
Machine Learning

Add ML Backend

Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL 
command:
```bash
curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\
--data '{"url": "http://localhost:9090", "project": {project_id}}'
post/api/ml/

Request body

auth_method'NONE' | 'BASIC_AUTH'

Auth method

basic_auth_passstring

Basic auth password

basic_auth_userstring

Basic auth user

descriptionstring

Description

extra_paramsobject

Extra parameters

is_interactiveboolean

Is interactive

projectinteger

Project ID

timeoutinteger

Response model timeout

titlestring

Title

urlstring

ML backend URL

Response

auth_method'NONE' | 'BASIC_AUTH'
  • NONE - None
  • BASIC_AUTH - Basic Auth
auto_updateboolean

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

basic_auth_pass_is_setboolean required
basic_auth_userstring nullable

HTTP Basic Auth user

created_atstring date-time required
descriptionstring nullable

Description for the machine learning backend

error_messagestring nullable

Error message in error state

{"stackTrail":"components:schemas:MLBackend:properties:extra_params","oasType":"schema","type":"unknown","description":"Any extra parameters passed to the ML Backend during the setup","nullable":true}
idinteger required
is_interactiveboolean

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

model_versionstring nullable

Current model version associated with this machine learning backend

projectinteger required
readable_statestring required
state'CO' | 'DI' | 'ER' | 'TR' | 'PR'
  • CO - Connected
  • DI - Disconnected
  • ER - Error
  • TR - Training
  • PR - Predicting
timeoutnumber double

Response model timeout

titlestring nullable

Name of the machine learning backend

updated_atstring date-time required
urlstring required

URL for the machine learning model server