API Reference
  • Introduction
  • Terminology
  • Authentication
  • Authentication
  • Basic operations
    • Create a batch
    • Create a job
    • Get project details
    • Get batch jobs
    • Get job result
  • Examples
  • Image Annotation
    • Create a job
    • Get job results
  • Image Segmentation
    • Create a job
    • Get job results
  • Video Segmentation
    • Create a job
    • Get job results
  • Video Annotation
    • Create a job
    • Get job results
  • 3D Point Cloud Annotation
    • Create a job
    • Output format
  • Point Cloud Segmentation
    • Create a job
    • Get job results
  • Secure Attachment Access
    • AWS S3
    • Google Cloud Storage
    • Azure Blob Storage
    • IP Whitelisting
    • Hybrid Cloud
  • Advanced
    • Creating jobs with pre-labeled data
  • Error Codes
    • Error Codes
Powered by GitBook
On this page

Was this helpful?

  1. Basic operations

Get project details

PROJECT BATCHES

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

Get list of batches in a project

Path Parameters

Name
Type
Description

project_id

string

ID of the project for which you want to get batches

Headers

Name
Type
Description

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
}
PreviousCreate a jobNextGet batch jobs

Last updated 11 months ago

Was this helpful?

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

Get batch jobs API
Get job result API