Get prediction details

GET

Get details about a specific prediction by its ID. To find the prediction ID, use List predictions.

For information about the prediction format, see the JSON format reference in the Label Studio documentation.

Path parameters

idintegerRequired

Prediction ID

Response

This endpoint returns an object.

resultlist of maps from strings to any

List of prediction results for the task

taskinteger

idintegerOptional

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

created_agostringOptionalDefaults to

Delta time from creation time

scoredoubleOptional

Prediction score

clusterintegerOptional

Cluster for the current prediction

neighborsmap from strings to anyOptional

Array of task IDs of the closest neighbors

mislabelingdoubleOptional

Related task mislabeling score

created_atdatetimeOptional

updated_atdatetimeOptional

modelintegerOptional

An ML Backend instance that created the prediction.

model_runintegerOptional

A run of a ModelVersion that created the prediction.

projectintegerOptional

GET

1 curl http://localhost:8080/api/predictions/1/ \
2      -H "Authorization: Token  <api_key>"

200Retrieved

1 {
2   "result": [
3     {
4       "original_width": 1920,
5       "original_height": 1080,
6       "image_rotation": 0,
7       "from_name": "bboxes",
8       "to_name": "image",
9       "type": "rectanglelabels",
10       "value": {
11         "x": 20,
12         "y": 30,
13         "width": 50,
14         "height": 60,
15         "rotation": 0,
16         "values": {
17           "rectanglelabels": [
18             "Person"
19           ]
20         }
21       }
22     }
23   ],
24   "task": 1,
25   "id": 1,
26   "model_version": "yolo-v8",
27   "created_ago": "created_ago",
28   "score": 0.95,
29   "cluster": 1,
30   "neighbors": {
31     "neighbors": {
32       "key": "value"
33     }
34   },
35   "mislabeling": 1.1,
36   "created_at": "2024-01-15T09:30:00Z",
37   "updated_at": "2024-01-15T09:30:00Z",
38   "model": 1,
39   "model_run": 1,
40   "project": 1
41 }

Built with

1	curl http://localhost:8080/api/predictions/1/ \
2	-H "Authorization: Token <api_key>"

1	{
2	"result": [
3	{
4	"original_width": 1920,
5	"original_height": 1080,
6	"image_rotation": 0,
7	"from_name": "bboxes",
8	"to_name": "image",
9	"type": "rectanglelabels",
10	"value": {
11	"x": 20,
12	"y": 30,
13	"width": 50,
14	"height": 60,
15	"rotation": 0,
16	"values": {
17	"rectanglelabels": [
18	"Person"
19	]
20	}
21	}
22	}
23	],
24	"task": 1,
25	"id": 1,
26	"model_version": "yolo-v8",
27	"created_ago": "created_ago",
28	"score": 0.95,
29	"cluster": 1,
30	"neighbors": {
31	"neighbors": {
32	"key": "value"
33	}
34	},
35	"mislabeling": 1.1,
36	"created_at": "2024-01-15T09:30:00Z",
37	"updated_at": "2024-01-15T09:30:00Z",
38	"model": 1,
39	"model_run": 1,
40	"project": 1
41	}