COcontext
Batch

List batches

Changed on

List your batches from newest to oldest. Filter by status or continue with a cursor.

get/batch/list

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/batch/list
  • Auth
    HTTP bearer

Query parameters

limitinteger

Batches per page. Defaults to 25.

cursorstring

Cursor from the previous page.

status'queued' | 'running' | 'cancelling' | 'completed' | 'cancelled' | 'failed'

Filter by status.

qstring

Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.

Example:batch_1a2b
search_type'exact' | 'prefix'

prefix for as-you-type prefix matching (default), exact for full-token matching.

tagsstring

Comma-separated list of tags to filter by (matches batches having any of them).

Example:docs,competitor

Response

Your batches, newest first. Use next_cursor to page through the rest.

has_moreboolean

Whether another page is available.

next_cursorstring nullable

Cursor for the next page.

Example response

{
  "data": [
    {
      "id": "batch_9f2c8a",
      "tags": [
        "docs"
      ],
      "crawl": {
        "source": {
          "url": "https://example.com/docs"
        },
        "max_pages": 500,
        "url_pattern": "^https://example\\.com/docs/"
      },
      "input": {
        "reserved": 24817,
        "submitted": 25000,
        "duplicates": 183
      },
      "progress": {
        "succeeded": 18091,
        "failed": 311,
        "pending": 6415
      },
      "credits": {
        "reserved": 24817,
        "refunded": 6726,
        "ocr_charged": 42,
        "net": 18091
      },
      "page_errors": [
        {
          "code": "WEBSITE_ACCESS_ERROR",
          "count": 204
        }
      ],
      "failure": {
        "code": "stalled",
        "message": "Batch stopped reporting progress and was finalized automatically"
      }
    }
  ]
}

Changes

  • 182f532c2552Revision changes
    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

  • 3c6a01ba967fRevision changes
    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status

    • info

      added subschema #1: Start URL subschema #2: Sitemap to the ///// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the ///// response property anyOf list for the response status

    • info

      added the required property /// to the response with the status