Sign in

v77

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-045764591.5 MB
Machine Learning

Test prediction

    After you add an ML backend, call this API with the ML backend ID to run a test prediction on specific task data
post/api/ml/{id}/predict/test

Path parameters

idinteger required

A unique integer value identifying this ML backend.

Request body

auth_method'NONE' | 'BASIC_AUTH'
  • NONE - None
  • BASIC_AUTH - Basic Auth
auto_updateboolean

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

basic_auth_passstring nullable
basic_auth_userstring nullable

HTTP Basic Auth user

descriptionstring nullable

Description for the machine learning backend

error_messagestring nullable

Error message in error state

{"stackTrail":"components:schemas:MLBackendRequest:properties:extra_params","oasType":"schema","type":"unknown","description":"Any extra parameters passed to the ML Backend during the setup","nullable":true}
is_interactiveboolean

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

model_versionstring nullable

Current model version associated with this machine learning backend

projectinteger required
state'CO' | 'DI' | 'ER' | 'TR' | 'PR'
  • CO - Connected
  • DI - Disconnected
  • ER - Error
  • TR - Training
  • PR - Predicting
timeoutnumber double

Response model timeout

titlestring nullable

Name of the machine learning backend

urlstring required

URL for the machine learning model server

Response

Predicting has successfully started.