VEverbiflow
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
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Request body

allow_external_linksboolean
allow_subdomainsboolean
contract_version'web-crawl.v1' required
countrystring nullable
crawl_entire_domainboolean
exclude_pathsstring[]
formatsstring[]
ignore_query_parametersboolean
include_pathsstring[]
languagesstring[]
limitinteger
max_concurrencyinteger
max_discovery_depthinteger nullable
only_main_contentboolean
page_timeout_msinteger
provider_deadline_secondsinteger
regex_on_full_urlboolean
sitemap'include' | 'skip' | 'only'
urlstring required

Response

Successful Response

accepted_pricingobject required
artifact_idstring required
execution_contract_digeststring required
execution_idstring required
failedboolean
finishedboolean
generation_idstring required
job_idstring required
operation_keystring required
phasestring
progress_currentinteger
progress_totalinteger required
request_digeststring required
result_kind'web_crawl'
rowsobject[]
semantic_fingerprintstring required
source_digeststring nullable
status'queued' | 'running' | 'blocked' | 'completed' | 'failed'
summaryobject required

Changes

No recorded changes to this operation across all 1 revision of this API.