POST
/
v2
/
batch
/
pause
API_KEY='live_...'
BATCH_ID='batch_123'
curl --request POST \
--url "https://api.scale.com/v2/batch/pause" \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{"batch_id": "'$BATCH_ID'"}'
{
  "batch": {
    "id": "batch_abc123",
    "name": "My Scale Batch",
    "project": "project_abc123",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "status": "staging",
    "callback": "https://example.com/callback",
    "metadata": {}
  },
  "message": "Batch pause initiated. Only unstarted tasks will be paused."
}

Batch Status Requirement

You can only pause batches that are currently in_progress. Batches in other statuses (staging, completed, paused) cannot be paused.

Once paused, the batch status will change to paused and all unstarted tasks will be paused.

Required request parameters

You are expected to provide one of the following in the request body:

  • 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.

Body

application/json

Response

200
application/json

Batch pause initiated successfully.

The response is of type object.