web

Start Web Search

post/api/web/search/start

Request

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

categoriesstring[]
contract_version'web-search.v2' | 'web-search.v3' required
countrystring nullable
coverage'standard' | 'expanded'
exclude_domainsstring[]
freshness'hour' | 'day' | 'week' | 'month' | 'year' nullable
ignore_invalid_urlsboolean
include_domainsstring[]
limit_per_sourceinteger
locationstring nullable
published_fromstring nullable
published_tostring nullable
queriesstring[] required
sourcesstring[]
timeout_msinteger

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_search'
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.