Get batch jobs

BATCH JOBS

GET https://api.playment.io/v1/projects/:project_id/batch/:batch_id?page_token=:next_page_token

Get a list of all jobs in a batch. The number of jobs in a batch is usually huge, so this API has pagination

Path Parameters

Name	Type	Description
next_page_token	string	You can leave this parameter blank for the first page. In the response of the first page, you'll get a token against the data.next_page_token key. Use this token to get the next page.
batch_id	string	ID of the batch for which you want to fetch a list of jobs
project_id	string	ID of the project which has this batch

Headers

Name	Type	Description
x-api-key	string	API key for authentication

200

{
    "data": {
        "id": "",
        "project_id": "",
        "name": "Batch 1",
        "jobs": [
            {
                "id": "fde5ert6-eb32-481a-807a-03a0428ca836",
                "reference_id": "001",
                "status": "completed",
                "frames": 1,
                "annotations": 1
            },
            {
                "id": "fdda8970-dr3d-4978-9ce3-e80654d8078c",
                "reference_id": "002",
                "status": "completed",
                "frames": 1,
                "annotations": 1
            }
        ],
        "next_page_token": "1575822103313046000"
    },
    "success": true
}

You can iterate over the list of jobs received in the response and call the Get job result API to get the annotation results for each job.