List Batches
List your batches from newest to oldest. Filter by status or continue with a cursor.
Authorizations
Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.
Query Parameters
Batches per page. Defaults to 25.
1 <= x <= 100Cursor from the previous page.
Filter by status.
queued, running, cancelling, completed, cancelled, failed Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.
200"batch_1a2b"
prefix for as-you-type prefix matching (default), exact for full-token matching.
exact, prefix Comma-separated list of tags to filter by (matches batches having any of them).
"docs,competitor"
Response
Your batches, newest first. Use next_cursor to page through the rest.
Batches on this page.
Whether another page is available.
Cursor for the next page.
Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.