Sign in

v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-31116192.0 KB
web-search

Run web/media search

Create a web-search job and wait for an inline result when responseMode is sync. If the job does not finish before the inline timeout, or when responseMode is async, the API returns a persisted job envelope. Every response includes X-Job-Id for later lookup.

post/v1/web-search

Request body

adverseTermsstring[]

Optional adverse-media terms to search alongside the subject. The service also uses a built-in adverse/legal/regulatory term pack.

maxResultsinteger
platformFiltersWebPlatform[]
responseMode'sync' | 'async'
seedUrlsstring[]

Example request

{
  "adverseTerms": [
    "fraud",
    "theft",
    "crime"
  ],
  "responseMode": "sync",
  "subject": {
    "name": "Jared Gizersky",
    "type": "person"
  }
}

Response

Normalized search hits when completed inline, otherwise a job envelope.

OR