Get job results
JOB RESULT
GET
https://api.playment.io/v1/projects/:project_id/jobs/:job_id
This endpoint allows you to get the annotations created on a job.
Path Parameters
Name | Type | Description |
---|---|---|
job_id | string | ID of the job. You would have received this ID in the response when you created the job. |
project_id | string | ID of the project where the job was created |
Headers
Name | Type | Description |
---|---|---|
x-api-key | string | API key for authentication |
ATTACHMENT
GET
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.
Path Parameters
Name | Type | Description |
---|---|---|
result_url | string | Result URL returned by the GET job result API |
Headers
Name | Type | Description |
---|---|---|
x-api-key | string | API key for authentication |
Result Object
The data.annotations_data.annotations
list contains objects where each object is an annotation. You can check the data structures in detail below:
Key | Description |
| A foreign key to join with the frame object in |
| All annotations across frames, belonging to the same object have a common |
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.
Last updated