v77

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

Predictions

Update prediction

Update prediction data by prediction ID.

patch/api/predictions/{id}/

Path parameters

idinteger required

Prediction ID

Request body

model_versionstring

Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface

resultobject[]

Prediction result in JSON format. Read more about the format in the Label Studio documentation.

scorenumber

Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first.

taskinteger

Task ID for which the prediction is created

Example request

{
  "model_version": "yolo-v8",
  "result": [
    {
      "from_name": "bboxes",
      "image_rotation": 0,
      "original_height": 1080,
      "original_width": 1920,
      "to_name": "image",
      "type": "rectanglelabels",
      "value": {
        "height": 60,
        "rotation": 0,
        "values": {
          "rectanglelabels": [
            "Person"
          ]
        },
        "width": 50,
        "x": 20,
        "y": 30
      }
    }
  ],
  "score": 0.95
}

Response

Updated prediction

clusterinteger nullable

Cluster for the current prediction

created_agostring required

Delta time from creation time

created_atstring date-time required

idinteger required

mislabelingnumber double

Related task mislabeling score

modelinteger nullable

An ML Backend instance that created the prediction.

model_runinteger nullable

A run of a ModelVersion that created the prediction.

model_versionstring

Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface

{"stackTrail":"components:schemas:Prediction:properties:neighbors","oasType":"schema","type":"unknown","description":"Array of task IDs of the closest neighbors","nullable":true}

projectinteger nullable

resultobject[] required

List of prediction results for the task

scorenumber double nullable

Prediction score

taskinteger required

updated_atstring date-time required