Get project details

PROJECT BATCHES

GET https://api.playment.io/v1/projects/:project_id/details

Get list of batches in a project

Path Parameters

NameTypeDescription

project_id

string

ID of the project for which you want to get batches

Headers

NameTypeDescription

x-api-key

string

API key for authentication

{
    "data": {
        "name": "Project XYZ",
        "base": "IMAGE",
        "batches": [
            {
                "id": "27f8303e-69fd-4b54-a4e9-63456571e195",
                "name": "Batch 1",
                "description": "These are the jobs created on 23rd August",
                "is_default": false,
                "total_jobs": 1427,
                "completed_jobs": 1427,
                "total_frames": 1427,
                "completed_frames": 1427,
                "annotations": 9392,
                "created_at": "2019-08-23T17:55:13.203229+05:30",
                "status": "Complete"
            },
            {
                "id": "10cab3e9-3f26-4c8b-83ac-3c138685120b",
                "name": "b2",
                "description": "",
                "is_default": false,
                "total_jobs": 4996,
                "completed_jobs": 4996,
                "total_frames": 4996,
                "completed_frames": 4996,
                "annotations": 12121,
                "created_at": "2019-12-06T15:42:36.23401+05:30",
                "status": "Complete"
            }            
        ]
    },
    "success": true
}

You can iterate over the list of batches received in the response to call the Get batch jobs API, which will give you a list of all the jobs in a batch. You can then iterate over this list and call the Get job result API to get the annotation results for each job.

Last updated