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

Create a batch

Before you create jobs, you need to create a batch to put those jobs in.

A batch is a collection of jobs. We recommend using batches to group datasets you use internally, or to group jobs which are part of a weekly submission.

A BATCH

POST https://api.playment.io/v1/projects/:project_id/batch

This endpoint allows you to create a batch

Path Parameters

Name
Type
Description

project_id

string

ID of the project in which you want to create the batch

Headers

Name
Type
Description

x-api-key

string

API key for authentication

Request Body

Name
Type
Description

name

string

Name of the batch

description

string

Help others understand what this batch consists of

{
    "success": True,
    "data":{
        "batch_id": "c9970ee2-6979-46f1-95db-eee0176294a8"
    }
}

The batch_id received in the response can be used to organize the jobs being created via the job creation API.

You can see the newly created batch inside the project in the GT Studio Jarvis dashboard.

PreviousAuthenticationNextCreate a job

Last updated 11 months ago

Was this helpful?