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"
}{
"status_code": 500,
"error": "An error has occurred."
}Batches
Get a Batch
Retrieve a Batch from its batch_id or batch_name.
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"
}{
"status_code": 500,
"error": "An error has occurred."
}Authentication
Authentication
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
bearerAuthbasicAuth
Your API Key is the Bearer token. See the Authentication section to learn how to access your key.
Query Parameters
Scale's unique identifier for the batch. A unique identifier for the batch.
Example:
"batch_abc123"
The name of the batch.
Example:
"My Scale Batch"
Response
Batch details.
A unique identifier for the batch.
Example:
"batch_abc123"
The name of the batch.
Example:
"My Scale Batch"
A timestamp formatted as an ISO 8601 date-time string.
Status of the batch.
Available options:
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.
Example:
"https://example.com/callback"