---
title: "Start Web Crawl"
method: POST
path: "/api/web/crawl/start"
tags: ["web"]
---

# Start Web Crawl

`POST /api/web/crawl/start`

## Request

- Base URL: `https://platform.verbiflow.com/api/bridge`
- URL: `https://platform.verbiflow.com/api/bridge/api/web/crawl/start`
- 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

- WebCrawlStartRequest
  - `allow_external_links` boolean
  - `allow_subdomains` boolean
  - `contract_version` 'web-crawl.v1', required
  - `country` string, nullable
  - `crawl_entire_domain` boolean
  - `exclude_paths` string[]
  - `formats` string[]
  - `ignore_query_parameters` boolean
  - `include_paths` string[]
  - `languages` string[]
  - `limit` integer
  - `max_concurrency` integer
  - `max_discovery_depth` integer, nullable
  - `only_main_content` boolean
  - `page_timeout_ms` integer
  - `provider_deadline_seconds` integer
  - `regex_on_full_url` boolean
  - `sitemap` 'include' | 'skip' | 'only'
  - `url` string, required

## Response `202`

Successful Response

- WebCrawlStartResponse
  - `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_crawl'
  - `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)