API ReferenceML

Add ML backend

Add an ML backend to a project. For more information about what you need to configure when adding an ML backend, see Connect the model to Label studio.

If you are using Docker Compose, you may need to adjust your ML backend URL. See localhost and Docker containers.
If you are using files that are located in the cloud, local storage, or uploaded to Label Studio, you must configure your environment variables to allow the ML backend to interact with those files. See Allow the ML backend to access Label Studio.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
urlstringOptional

ML backend URL

projectintegerOptional

Project ID

is_interactivebooleanOptional

Is interactive

titlestringOptional

Title

descriptionstringOptional

Description

auth_methodenumOptional

Auth method

Allowed values:
basic_auth_userstringOptional

Basic auth user

basic_auth_passstringOptional

Basic auth password

extra_paramsmap from strings to anyOptional

Extra parameters

timeoutintegerOptional

Response model timeout

Response

urlstringOptional

ML backend URL

projectintegerOptional

Project ID

is_interactivebooleanOptional

Is interactive

titlestringOptional

Title

descriptionstringOptional

Description

auth_methodenumOptional

Auth method

Allowed values:
basic_auth_userstringOptional

Basic auth user

basic_auth_passstringOptional

Basic auth password

extra_paramsmap from strings to anyOptional

Extra parameters

timeoutintegerOptional

Response model timeout