Batch Info

Retrieves the status and progress information about a batch. To retrieve the content for a batch, see here

GET /v1/batches/{batch_id}

Retrieve batch information

cURL

curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "created": 123,
  "total_urls": 123,
  "completed_urls": 123,
  "parser": "<string>",
  "country": "<string>",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "processed": "true"
  },
  "webhook": "<string>",
  "credits_consumed": 123,
  "cost_usd": 123
}

Attach custom data: Use the metadata parameter to store key-value pairs with your batch. See Metadata for details.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

batch_id · string · required

The ID of the batch to retrieve information for.

Response

200

application/json

Successful response with batch information.

id · string

Batch ID

object · string

The kind of object. "batch" for this endpoint.

status · string

in_progress or completed

created · number

Created epoch

total_urls · number

Count of URLs in the batch

completed_urls · number

Count of completed URLs

parser · string

country · string

metadata · object

Set of key-value pairs for storing additional information about an object. Follows Stripe's approach with validation rules: max 50 keys, key max 40 characters (no square brackets), value max 500 characters, all values stored as strings.

Show child attributes

Example:

{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}

webhook · string

Webhook URL to receive completion notification

credits_consumed · integer | null

Number of credits consumed by this request. Populated after execution completes. Credits are the source of truth for billing.

cost_usd · number | null

Estimated cost in USD for this request. Populated after execution completes. Calculated from credits consumed and your plan rate — 99% accurate, but credits_consumed is the authoritative value.