---
title: "Start Web Page Extract Batch"
method: POST
path: "/api/web/page/extract/start-batch"
tags: ["web"]
---

# Start Web Page Extract Batch

`POST /api/web/page/extract/start-batch`

## Request

- Base URL: `https://platform.verbiflow.com/api/bridge`
- URL: `https://platform.verbiflow.com/api/bridge/api/web/page/extract/start-batch`
- Auth: one of:
  - HTTP bearer and API key in header `x-flage-org-id`
  - HTTP bearer and API key in header `x-flage-org-slug`

## Request body

- WebCaptureBatchStartRequest
  - `items` WebCaptureBatchItemRequest[], required
    - `operation` string, required
    - `request` WebPageExtractStartRequest, required
      - `contract_version` 'web-capture.v2' | 'web-capture.v3', required
      - `country` string, nullable
      - `formats` string[]
      - `languages` string[]
      - `max_age_ms` integer
      - `network` WebNetworkCaptureRequest
        - `exclude_url_patterns` string[]
        - `include_url_patterns` string[]
        - `max_concurrency` integer
        - `max_requests` integer
        - `max_total_body_bytes` integer
        - `record_headers` boolean
        - `request_body` 'none' | 'text'
        - `resource_types` string[]
        - `response_body` 'none' | 'text'
        - `settle_time_ms` integer
      - `only_main_content` boolean
      - `timeout_ms` integer
      - `urls` string[], required

## Response `202`

Successful Response

- WebCaptureBatchStartResponse
  - `batch_id` string, required
  - `results` WebCaptureStartResponse[], required
    - `accepted_pricing` object, required
    - `artifact_id` string, required
    - `execution_contract_digest` string, required
    - `execution_id` string, required
    - `failed` boolean
    - `finished` boolean
    - `generation_id` string, required
    - `job_id` string, required
    - `operation_key` string, required
    - `phase` string
    - `progress_current` integer
    - `progress_total` integer, required
    - `request_digest` string, required
    - `result_kind` 'web_capture'
    - `rows` object[]
    - `semantic_fingerprint` string, required
    - `source_digest` string, nullable
    - `status` 'queued' | 'running' | 'blocked' | 'completed' | 'failed'
    - `summary` object, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract.md) - [All operations](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/llms.txt) - [OpenAPI document](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/revisions/c80e903ef8f3?raw)
