Extract

Extract Batch Endpoint

post/v1/extract/batch

Request body

Example request

{
  "inputs": [
    {
      "auto_driver_configuration": {
        "vx10": 2,
        "vx10-pro": 0,
        "vx6-fast": 1,
        "vx6-stealth": 1,
        "vx8": 5,
        "vx8-pro": 5
      },
      "body": {
        "key": "value"
      },
      "browser": "chrome",
      "browser_actions": [
        {
          "goto": "https://example.com/login"
        },
        {
          "wait_for_element": "#login-form"
        },
        {
          "fill": {
            "selector": "#username",
            "value": "user@example.com"
          }
        },
        {
          "fill": {
            "selector": "#password",
            "value": "password123"
          }
        },
        {
          "click": "#submit"
        },
        {
          "screenshot": {
            "full_page": true
          }
        }
      ],
      "city": "Los Angeles",
      "cookies": "sessionId=abc123; userId=user456",
      "device": "desktop",
      "driver": "vx8",
      "expected_status_codes": [
        200,
        201
      ],
      "formats": [
        "html"
      ],
      "headers": {
        "Accept-Language": "en-US",
        "User-Agent": "CustomBot/1.0"
      },
      "http2": true,
      "is_xhr": true,
      "markdown_backend": "full_page",
      "method": "GET",
      "network_capture": [
        {
          "resource_type": "document"
        }
      ],
      "os": "windows",
      "parse": true,
      "realtime_total_timeout": 15000,
      "request_timeout": 30000,
      "skill": "dynamic-content",
      "state": "CA",
      "tag": "campaign-2024-q1",
      "callback_url": "https://example.com/webhook/callback",
      "storage_compress": true,
      "storage_object_name": "result-2024-01-15.json",
      "storage_type": "s3",
      "storage_url": "s3://bucket-name/path/to/object"
    }
  ],
  "shared_inputs": {
    "auto_driver_configuration": {
      "vx10": 2,
      "vx10-pro": 0,
      "vx6-fast": 1,
      "vx6-stealth": 1,
      "vx8": 5,
      "vx8-pro": 5
    },
    "body": {
      "key": "value"
    },
    "browser": "chrome",
    "browser_actions": [
      {
        "goto": "https://example.com/login"
      },
      {
        "wait_for_element": "#login-form"
      },
      {
        "fill": {
          "selector": "#username",
          "value": "user@example.com"
        }
      },
      {
        "fill": {
          "selector": "#password",
          "value": "password123"
        }
      },
      {
        "click": "#submit"
      },
      {
        "screenshot": {
          "full_page": true
        }
      }
    ],
    "city": "Los Angeles",
    "cookies": "sessionId=abc123; userId=user456",
    "device": "desktop",
    "driver": "vx8",
    "expected_status_codes": [
      200,
      201
    ],
    "formats": [
      "html"
    ],
    "headers": {
      "Accept-Language": "en-US",
      "User-Agent": "CustomBot/1.0"
    },
    "http2": true,
    "is_xhr": true,
    "markdown_backend": "full_page",
    "method": "GET",
    "network_capture": [
      {
        "resource_type": "document"
      }
    ],
    "os": "windows",
    "parse": true,
    "realtime_total_timeout": 15000,
    "request_timeout": 30000,
    "skill": "dynamic-content",
    "state": "CA",
    "tag": "campaign-2024-q1",
    "callback_url": "https://example.com/webhook/callback",
    "storage_compress": true,
    "storage_object_name": "result-2024-01-15.json",
    "storage_type": "s3",
    "storage_url": "s3://bucket-name/path/to/object"
  }
}

Response

Batch created successfully

batch_idstring required

Unique identifier for the batch.

batch_sizenumber required

Number of tasks in the batch.

Example response

{
  "tasks": [
    {
      "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
      "created_at": "2024-01-15T10:30:00Z",
      "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
      "error": "Connection timeout",
      "error_type": "timeout_error",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "modified_at": "2024-01-15T10:35:00Z",
      "state": "pending",
      "status_code": 200,
      "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

Changed in 10 of the 55 revisions of this API.6825

Aug 17, 202622c2a22911462See the full diff
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/realtime_total_timeout
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/realtime_total_timeout
  new-optional-request-property
This revision also has 104 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 12, 2026e8a97dc9fce252See the full diff
- ▲
  response property tasks/items/batch_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/download_url list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/error list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/error_type list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/output_url list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/session/renew_on_blocked
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/session/renew_on_blocked
  new-optional-request-property
This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 2026ebe52c375b7137See the full diff
- ●
  added the new in_progress enum value to the tasks/items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new labs enum value to the tasks/items/api_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new queued enum value to the tasks/items/state response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/auto_driver_configuration
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/auto_driver_configuration
  new-optional-request-property
- ○
  added the new auto enum value to the request property inputs/items/allOf[subschema #1]/driver
  request-property-enum-value-added
- ○
  added the new auto enum value to the request property shared_inputs/allOf[subschema #1]/driver
  request-property-enum-value-added
- ○
  added the new fast-vx6 enum value to the request property inputs/items/allOf[subschema #1]/driver
  request-property-enum-value-added
- ○
  added the new fast-vx6 enum value to the request property shared_inputs/allOf[subschema #1]/driver
  request-property-enum-value-added
- ○
  added the optional property tasks/items/queue to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 20262562e655b8f22See the full diff
- ○
  request property inputs/items/allOf[subschema #1]/render list-of-types was widened by adding types string to media type application/json
  request-property-list-of-types-widened
- ○
  request property shared_inputs/allOf[subschema #1]/render list-of-types was widened by adding types string to media type application/json
  request-property-list-of-types-widened
Jun 10, 2026421a9851d61b12See the full diff
- ●
  added the new fast-serp enum value to the tasks/items/api_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/body
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/body
  new-optional-request-property
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 23, 2026b746af292a142See the full diff
- ●
  removed the request property inputs/items/allOf[subschema #1]/network_capture/items/stop_on_render_flow_failure
  request-property-removed
- ●
  removed the request property shared_inputs/allOf[subschema #1]/network_capture/items/stop_on_render_flow_failure
  request-property-removed
Apr 15, 20260926a0595c5d4See the full diff
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/markdown_backend
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/markdown_backend
  new-optional-request-property
- ○
  added the new links enum value to the request property inputs/items/allOf[subschema #1]/formats/items/
  request-property-enum-value-added
- ○
  added the new links enum value to the request property shared_inputs/allOf[subschema #1]/formats/items/
  request-property-enum-value-added
Apr 6, 20265f8038fd72644See the full diff
- ○
  added the new optional request property inputs/items/allOf[subschema #1]/network_capture/items/stop_on_render_flow_failure
  new-optional-request-property
- ○
  added the new optional request property shared_inputs/allOf[subschema #1]/network_capture/items/stop_on_render_flow_failure
  new-optional-request-property
- ○
  added the new media-vx6 enum value to the request property inputs/items/allOf[subschema #1]/driver
  request-property-enum-value-added
- ○
  added the new media-vx6 enum value to the request property shared_inputs/allOf[subschema #1]/driver
  request-property-enum-value-added
Mar 25, 2026403f2145d293121See the full diff
- ▲
  added the new required request property inputs
  new-required-request-property
- ●
  removed the request property params
  request-property-removed
- ●
  removed the request property shared_params
  request-property-removed
- ○
  added the new optional request property shared_inputs
  new-optional-request-property
Mar 17, 2026a57961a8289c1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history