Create prediction

POST

http://localhost:8000/api/predictions/

POST

/api/predictions/

$ curl -X POST http://localhost:8000/api/predictions/ \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "result": [
>     {}
>   ],
>   "task": 1
> }'

201response

1 {
2   "created_ago": "",
3   "created_at": "2024-06-18T23:45:46.048490Z",
4   "id": 1,
5   "result": [
6     {
7       "from_name": "bboxes",
8       "image_rotation": 0,
9       "original_height": 1080,
10       "original_width": 1920,
11       "to_name": "image",
12       "type": "rectanglelabels",
13       "value": {
14         "height": 60,
15         "rotation": 0,
16         "values": {
17           "rectanglelabels": [
18             "Person"
19           ]
20         },
21         "width": 50,
22         "x": 20,
23         "y": 30
24       }
25     }
26   ],
27   "task": 1,
28   "updated_at": "2024-06-18T23:45:46.048538Z",
29   "model_version": "yolo-v8",
30   "project": 1,
31   "score": 0.95
32 }

Create a prediction for a specific task.

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>

Request

This endpoint expects an object.

resultlist of objectsRequired

List of prediction results for the task

taskintegerRequired

clusterinteger or nullOptional-2147483648-2147483647

Cluster for the current prediction

mislabelingdoubleOptional

Related task mislabeling score

modelinteger or nullOptional

An ML Backend instance that created the prediction.

model_runinteger or nullOptional

A run of a ModelVersion that created the prediction.

model_versionstringOptional

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

neighborsany or nullOptional

Array of task IDs of the closest neighbors

projectinteger or nullOptional

scoredouble or nullOptional

Prediction score

Response

Created prediction

created_agostringRead-onlyDefaults to

Delta time from creation time

created_atdatetimeRead-only

idintegerRead-only

resultlist of objects