API ReferenceML

List ML backends

List all configured ML backends for a specific project by ID. Use the following cURL command: ```bash curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query Parameters

projectintegerOptional
Project ID

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