API_KEY='live_...'
curl --request POST \
--url "https://api.scale.com/v2/batch" \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "My New Batch",
"project": "project_123"
}'{
"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"
}{
"status_code": 500,
"error": "An error has occurred."
}Create a Batch
Create a new Batch for organizing tasks.
API_KEY='live_...'
curl --request POST \
--url "https://api.scale.com/v2/batch" \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "My New Batch",
"project": "project_123"
}'{
"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"
}{
"status_code": 500,
"error": "An error has occurred."
}Authentication
Authentication
Required request parameters
You must provide:- Name (
name) - The name for the batch - Project (
project) - Project ID or project name to associate with the batch
Authorizations
Your API Key is the Bearer token. See the Authentication section to learn how to access your key.
Body
The name of the batch.
"My Scale Batch"
A unique identifier for the project.
"project_abc123"
The name of the project.
"My Scale Project"
Callback URL or email for the entity upon completion.
"https://example.com/callback"
Whether this is a staging batch.
Custom metadata for the entity.
Response
Batch created successfully.
A unique identifier for the batch.
"batch_abc123"
The name of the batch.
"My Scale Batch"
A timestamp formatted as an ISO 8601 date-time string.
Status of the batch.
staging, in_progress, completed, paused, cancelled Custom metadata for the entity.
UTC timestamp when the batch was completed.
Callback URL or email for the entity upon completion.
"https://example.com/callback"