Skip to main content
GET
/
v2
/
batch
API_KEY='live_...'
BATCH_ID='batch_123'
curl --request GET \
    --url "https://api.scale.com/v2/batch?batch_id=$BATCH_ID" \
    --header "Authorization: Bearer $API_KEY"
{
  "id": "batch_123",
  "name": "Batch Name Example",
  "project": "project_123",
  "created_at": "2022-07-25T07:32:34.318Z",
  "status": "completed",
  "callback": "https://example.com/callback",
  "metadata": {},
  "completed_at": "2022-07-26T07:32:34.318Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.genai.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Every request sent to Scale’s API requires authentication. In short, your API Key is the Bearer token. See the Authentication section for more details.

​
Required query parameters

You are expected to provide one of the following:
  • Batch ID (batch_id)
  • Batch Name (batch_name)

Authorizations

​
Authorization
string
header
required

Your API Key is the Bearer token. See the Authentication section to learn how to access your key.

Query Parameters

​
batch_id
string

Scale's unique identifier for the batch. A unique identifier for the batch.

Example:

"batch_abc123"

​
batch_name
string

The name of the batch.

Example:

"My Scale Batch"

​
expand
enum<string>[]

List of fields to expand in the response. Entities that can be expanded from an ID to an object.

Entities that can be expanded from an ID to an object.

Available options:
project

Response

Batch details.

​
id
string
required

A unique identifier for the batch.

Example:

"batch_abc123"

​
name
string
required

The name of the batch.

Example:

"My Scale Batch"

​
project
required

Project ID or Project associated with the batch.

Example:

"project_abc123"

​
created_at
string<date-time>
required

A timestamp formatted as an ISO 8601 date-time string.

​
status
enum<string>
required

Status of the batch.

Available options:
staging,
in_progress,
completed,
paused,
cancelled
​
metadata
object
required

Custom metadata for the entity.

​
completed_at
string<date-time>

UTC timestamp when the batch was completed.

​
callback
string

Callback URL or email for the entity upon completion.

Example:

"https://example.com/callback"