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>",
      "html_content": "<string>",
      "markdown_content": "<string>",
      "json_content": "<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 the list of URLs and retrieve_id for.

Query Parameters

​
status
enum<string>

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

Available options:
completed,
failed
​
cursor
integer

Optional integer representing the index to start fetching content from. Useful to paginate until all URLs are fetched.

Start with 0, then provide response['cursor'] value of the last request.

​
limit
integer

Optional integer to limit the number of results returned. Recommended 10-50 results at a time. Paginated using cursor.

Maximum 10MB of content can be fetched in a single request.

​
formats
enum<string>[]

Deprecated: Use /retrieve endpoint with retrieve_id.

Array of formats to fetch (e.g., ["html", "markdown"]).

Response

Successful response with the list of URLs.

​
batch_id
string

Batch ID

​
object
string

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

​
status
string

in_progress or completed

​
items
object[]
​
items_count
integer
​
cursor
integer

To be passed in the query in next request to get the next items.