API ReferenceML

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:

$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}}'

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

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
Allowed values:
timeoutdouble or null
Response model timeout
titlestring or null
Name of the machine learning backend