Skip to main content
GET
/
v1
/
batches
/
{batch_id}
/
items
Retrieve completed or failed items list optionally with content for a specific batch
curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id}/items \
  --header 'Authorization: Bearer <token>'
{
  "batch_id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "items": [
    {
      "custom_id": "<string>",
      "retrieve_id": "<string>",
      "url": "<string>",
      "links_on_page": [
        "<string>"
      ]
    }
  ],
  "items_count": 123,
  "cursor": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
batch_id
string
required

The ID of the batch to retrieve items for.

Query Parameters

​
status
enum<string>

Status of the URLs to retrieve (completed or failed).

Available options:
completed,
failed
​
cursor
integer

Pagination cursor. Omit this parameter on the first request. For subsequent requests, use the cursor value from the previous response. See Pagination for details.

​
limit
integer

Number of results to return (recommended 10-50).

Response

Successful response with batch items.

​
batch_id
string
​
object
string
​
status
string
​
items
object[]
​
items_count
integer
​
cursor
integer

Pagination cursor. Present when there are more results available. Use this value in the next request's cursor parameter. See Pagination for details.