Skip to main content
GET
Retrieve completed or failed items list optionally with content for a specific batch
Pagination: Without limit, this endpoint returns up to 10000 items (the maximum). If the response includes a cursor, more items remain. Call again with that cursor until it is absent. See Paginate or Stream.
Metadata: If you attached metadata to individual items when creating the batch, it will be returned with each item in the response.

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 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 on the first request. When the previous response includes cursor, pass that value to fetch the next page. See Paginate or Stream.

limit
integer
default:10000

Maximum number of items to return. Defaults to 10000. Maximum is 10000. When more items remain, the response includes a cursor. Pass it on the next request.

Required range: 1 <= x <= 10000

Response

Successful response with batch items.

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

Pagination cursor. Present when more items remain. Pass this value as the next request's cursor. Absent on the last page of a completed batch. See Paginate or Stream.