For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
EnterpriseQuick Start
API ReferenceTutorials
  • Introduction
    • Getting started
  • API Reference
      • GETList predictions
      • POSTCreate prediction
      • GETGet prediction details
      • DELDelete prediction
      • PATCHUpdate prediction
LogoLogo
EnterpriseQuick Start
API ReferencePredictions

Get prediction details

GET
http://localhost:8000/api/predictions/:id/
GET
/api/predictions/:id/
$curl http://localhost:8000/api/predictions/1/ \
>     -H "Authorization: Token  <api_key>" \
>     -H "Content-Type: application/json"
200response
1{
2  "created_ago": "5 minutes 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": 101,
28  "updated_at": "2024-06-18T23:45:46.048538Z",
29  "model_version": "yolo-v8",
30  "project": 12,
31  "score": 0.95
32}
Get details about a specific prediction by its ID.
Was this page helpful?
Previous

Delete prediction

Next
Built with

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: 
curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

Path parameters

idintegerRequired
Prediction ID

Response

Prediction details
created_agostringRead-onlyDefaults to
Delta time from creation time
created_atdatetimeRead-only
idintegerRead-only
resultlist of objects
List of prediction results for the task
taskinteger
updated_atdatetimeRead-only
clusterinteger or null-2147483648-2147483647
Cluster for the current prediction
mislabelingdouble
Related task mislabeling score
modelinteger or null
An ML Backend instance that created the prediction.
model_runinteger or null
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

neighborsany or null
Array of task IDs of the closest neighbors
projectinteger or null
scoredouble or null
Prediction score