Update ML Backend

PATCH

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

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

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>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

auth_methodenumOptional

NONE - None
BASIC_AUTH - Basic Auth

auto_updatebooleanOptional

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

basic_auth_passstring or nullOptional

basic_auth_userstring or nullOptional

HTTP Basic Auth user

descriptionstring or nullOptional

Description for the machine learning backend

extra_paramsany or nullOptional

Any extra parameters passed to the ML Backend during the setup

is_interactivebooleanOptional

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

model_versionstring or nullOptional

Current model version associated with this machine learning backend

projectintegerOptional

timeoutdoubleOptional

Response model timeout

titlestring or nullOptional

Name of the machine learning backend

urlstringOptional>=1 character

URL for the machine learning model server

Response

basic_auth_pass_is_setbooleanRead-only

created_atdatetimeRead-only

idintegerRead-only

projectinteger

readable_statestringRead-only

updated_atdatetimeRead-only

urlstring