post https://api.playment.in/v1
POST
https://api.playment.io/v0/projects/ <project_id>/jobs
Each request represents one unit of data that you would want annotated.
In case of a non-sequential data it would be one image or point cloud data.
In case of sequential data it would be an array of data links corresponding to the annotation request of interest
Parameters
project_id
: To be passed in the URL
x-api-key
: Secret key to be passed as a header
{
"reference_id": "001",
"data": {
"Depends on the type of Job. Check out the various sections below to see different data based on the type of job"
},
"tag": "Sample-task",
"batch_id": "72c888f6-b365-4f27-ad57-d7841da2de0c",
"priority_weight": 5
}
{
"data": {
"job_id": "3f3e8675-ca69-46d7-aa34-96f90fcbb732",
"reference_id": "001",
"tag": "Sample-task"
},
"success": true
}
Request Key | Request Value |
---|---|
reference_id | reference_id is a unique identifier for a request. We'll fail a request if you've sent another request with the same reference_id previously. This helps us ensure that we don't charge you for work which we've already done for you. |
tag | Each request should have a tag which tells us what operation needs to be performed on that request. We'll share this tag with you during the integration process. |
data | This has the complete data that is to be annotated. It will be different for a different type of annotation use-cases, check the section given below to know more |
batch_id Optional | String A batch is a way to organize multiple sequences under one batch_idRefer to Creating a batch |
priority_weight Optional | Number Its value ranges from 1 to 10 with 1 being lowest, 10 being highest.Default value 5 |
job_id
is the unique ID of a job. This will be used to get the job result
QPS
Playment's POST API currently supports up to 20 requests per second.