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

Simple Segmentation
Instance Aware Segmentation
Simple Segmentation
{
"legend": {
"#fdffd34": "Car",
"#f23334": "Sky",
"#fd2d34": "Tree"
},
"url": "https://playment-data-uploads.s3.ap-south-1.amazonaws.com/clients/e81bddc9-e39c-4a7f-bef4-caee6f757009/projects/6f5ed111-1a46-4e06-8d72-c0dec50ac0b7/batch_export_result/0f0abfb5-4c5f-4838-a89e-92d5234b0b09/576d8391-0ce5-4cd4-969a-f3806e1cf2f4/source.png"
}
Instance Aware Segmentation
{
"legend": {
"#00c537": "car # 1",
"#01d9fc": "pedestrian # 1",
"#fac1c2": "pedestrian # 2",
"#fb0379": "pedestrian # 3",
"#fcbe92": "car # 2",
"#fda7df": "vegetation"
},
"url": "https://playment-data-uploads.s3.ap-south-1.amazonaws.com/clients/e81bddc9-e39c-4a7f-bef4-caee6f757009/projects/6f5ed111-1a46-4e06-8d72-c0dec50ac0b7/batch_export_result/0f0abfb5-4c5f-4838-a89e-92d5234b0b09/576d8391-0ce5-4cd4-969a-f3806e1cf2f4/source.png"
}

To access the PNG mask (url in the result object), you will need to use the GET Attachment API.

The mask is a PNG file with four 8-bit channels. The first 3 channels are R, G & B respectively. These can be used to obtain a hex code for any pixel, which then maps to a class or instance based on thelegend object.