[Go to site: main page, start]
API ReferenceML

Get ML Backend

Get details about a specific ML backend connection by ID. For example, make a GET request using the following cURL command: ```bash curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'

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

Response

basic_auth_pass_is_setbooleanRead-only
created_atdatetimeRead-only
idintegerRead-only
projectinteger
readable_statestringRead-only
updated_atdatetimeRead-only
urlstring
URL for the machine learning model server
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_userstring or nullOptional
HTTP Basic Auth user
descriptionstring or nullOptional
Description for the machine learning backend
error_messagestring or nullOptional
Error message in error state
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
stateenumOptional
  • CO - Connected
  • DI - Disconnected
  • ER - Error
  • TR - Training
  • PR - Predicting
timeoutdoubleOptional
Response model timeout
titlestring or nullOptional
Name of the machine learning backend