Get job results

get
JOB RESULT

https://api.playment.io/v1/projects/:project_id/jobs/:job_id
This endpoint allows you to get the annotations created on a job.
Request
Response
Request
Path Parameters
job_id
required
string
ID of the job. You would have received this ID in the response when you created the job.
project_id
required
string
ID of the project where the job was created
Headers
x-api-key
required
string
API key for authentication
Response
200: OK
Job results successfully retrieved.
{
"data": {
"project_id": "905ea3ee-6f62-4bb7-8c31-471e486d9202",
"reference_id": "001",
"job_id": "3f3e8675-ca69-46d7-aa34-96f90fcbb732",
"batch_id": "468b6ae3-e98d-4d08-9427-b6e7a016054c",
"status": "completed",
"work_flow_id": "2aae1234-acac-1234-eeff-12a22a237bbc",
"result": "https://playment-data-uploads.s3.ap-south-1.amazonaws.com/sample-result.json"
},
"success": true
}

get
ATTACHMENT

https://api.playment.io/v1/attachments?url=:result_url
The result_url (data.result) returned by the GET Job result API is a private URL (Well, it's public till 15th July 2021, after which we'll enforce it to be private). You need to use this Attachment access API to securely fetch the results. Please refer to the Attachment Access API document for more detail.
Request
Response
Request
Path Parameters
result_url
required
string
Result URL returned by the GET job result API
Headers
x-api-key
required
string
API key for authentication
Response
200: OK
The API will redirect to a signed URL of the attachment

Result Object

{
"data": {
"annotation_data": {
"annotations": []
"sensor_data": {
"frames": [] //This is the same list you sent while creating the job
}
}
}

The data.annotations_data.annotations list contains objects, where each object is an annotation. You can check the data structures for various annotation types below:

3D Bounding Box
2D Bounding Box
3D Bounding Box
{
"_id": "d7c444e2-f041-46cc-bda0-25ae35801dac",
"label": "car",
"color": "rgb(151,22,15)",
"attributes": {},
"keyFrame": true,
"sensor_id": "lidar",
"frame_id": "0001",
"track_id": "d7c444e2-f041-46cc-bda0-25ae35801dac",
"type": "cuboid3d",
"source": "pointcloud"
"dimensions": {
"length": 3.2802,
"width": 1.352,
"height": 1.7
},
"center": {
"x": 9.8138,
"y": 0.3344,
"z": 0.9557
},
"rotation": {
"_w": -0.9952638830524981,
"_x": -0.008698959266850841,
"_y": -0.0006932023355776871,
"_z": -0.09681761549149911
}
}
2D Bounding Box
{
"_id": "d7c444e2-f041-46cc-bda0-25ae35801dac",
"attributes": {},
"sensor_id": "front_main",
"frame_id": "0001",
"track_id": "d7c444e2-f041-46cc-bda0-25ae35801dac",
"type": "rectangle",
"source": "images"
"label": "car",
"coordinates": [
{
"x": 0,
"y": 0
},
{
"x": 0,
"y": 0
},
{
"x": 0,
"y": 0
},
{
"x": 0,
"y": 0
}
]
}

Key

Description

frame_id

A foreign key to join with the frame object in sensor_data.frames

track_id

All annotations across frames, belonging to the same object have a common track_id

sensor_id

The sensor in which the annotation is present