Create a job
post
https://api.playment.io
/v1/projects/:project_id/jobs
A JOB
After creating the job, please store the job_id received in the response. You'll use this job_id to get the annotations later.

Body Parameters

Project ID

After opening a project, You can find the project_id in the information tooltip or URL.

Workflow ID

Batch ID

In the Batches section of a project, You can find the batch_id in the batch information tooltip.

Payload

The payload data structure varies depending on the type of task

Image Annotation & Image Segmentation

{
"reference_id":"001",
"data":{
"image_url":"https://s3.aws.com/600x400/000/fff.jpg"
},
"work_flow_id":"2aae1234-acac-1234-eeff-12a22a237bbc"
}

Video Annotation

{
"reference_id":"001",
"data":{
"video_data": {
"frames": [
{
"frame_id": "frame001",
"src": "https://dummyimage.com/600x400/000/fff.jpg"
},
{
"frame_id": "frame002",
"src": "https://dummyimage.com/600x400/000/fff.jpg"
},
{
"frame_id": "frame003",
"src": "https://dummyimage.com/600x400/000/fff.jpg"
},
{
"frame_id": "frame004",
"src": "https://dummyimage.com/600x400/000/fff.jpg"
},
{
"frame_id": "frame005",
"src": "https://dummyimage.com/600x400/000/fff.jpg"
}
]
}
},
"work_flow_id":"2aae1234-acac-1234-eeff-12a22a237bbc"
}

Attachment Access

The attachments you pass in the job creation requests ultimately need to be made available to the annotators who make the annotations in GT Studio. Depending on the type of workforce and whether you agree to give Playment access to your data, there are a couple of methods through which you can provide access to these attachments:
Workforce Type
Playment can access?
Method
Managed by Playment
Yes
Not managed by Playment
Yes
Not managed by Playment
No

Errors

For details on possible errors, please follow this link: