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 `re
/v1/web-searchRequires X-API-Key or Authorization: Bearer with a provisioned API key.
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.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
adverseTerms | array<string> | No | Optional adverse-media terms to search alongside the subject. The service also uses a built-in adverse/legal/regulatory term pack. |
dateRange | WebSearchDateRange or null | No | — |
maxResults | integer | No | Maxresults Default: 50 |
platformFilters | array<WebPlatform> | No | Platformfilters Default: ["web", "news"] |
responseMode | ResponseMode | No | Default: "sync" |
seedUrls | array<string> | No | Seedurls |
socialAccounts | array<WebSearchSocialAccount> | No | Socialaccounts |
subject | WebSearchSubject | Yes | — |
Request examples
Person web/media search
Search public web/media with built-in adverse discovery for a person subject.
{
"adverseTerms": [
"fraud",
"theft",
"crime"
],
"responseMode": "sync",
"subject": {
"name": "John Smith",
"type": "person"
}
}Responses
200
Normalized search hits when completed inline, otherwise a job envelope.
Schema: WebSearchResult or JobEnvelope_WebSearchResult_
422
Validation Error
| Field | Type | Required | Description |
|---|---|---|---|
detail | array<ValidationError> | No | Detail |
OpenAPI
Download the full OpenAPI contract from /openapi.yaml.