Skip to main content
POST
Initialize job

Authorizations

x-api-key
string
header
required

API key for authentication.

Body

application/json

Request to get validator, enrichment, and date range suggestions for a query.

query
string
required

Plain text question describing what to find.

The system analyzes your input to generate search queries, validators, and extractors. More specific queries produce more focused results.

Example:

"Series B funding rounds for SaaS startups"

context
string

Additional context to focus on specific aspects of your query.

Example:

"Focus on funding amount and company name"

connected_dataset_ids
string<uuid>[]

Optional list of watchlist dataset IDs connected to this job.

fetch_all_watchlist_news
boolean
default:false

When true, returns generic news validators and enrichments suitable for watchlist-based article collection instead of query-specific fields.

Response

Suggestions retrieved successfully

query
string
required

Echo of the query from the request.

Example:

"Series B funding rounds for SaaS startups"

validators
object[]
required

Suggested validators for filtering relevant web pages. When the job is submitted, the system may inject additional validators during the analyzing stage — check the returned validators[] in the job status to see the complete applied set.

enrichments
object[]
required

Suggested enrichment fields for data extraction.

context
string | null

Echo of the context from the request. Null if not provided.

Example:

"Focus on funding amount and company name"

start_date
string<date-time>

Start date for web search (ISO 8601 format with UTC timezone).

Defines the start of the search window by web page discovery date, not event date. Web pages discovered within this range may describe events from any time period.

Must be within plan's allowed search depth. Default is 5 days before current date if not specified.

Example:

"2026-01-30T00:00:00Z"

end_date
string<date-time>

End date for web search (ISO 8601 format with UTC timezone).

Defines the end of the search window by web page discovery date, not event date. Web pages discovered within this range may describe events from any time period.

Must be within plan's allowed search depth and after start_date. Default is current date if not specified.

Example:

"2026-02-05T00:00:00Z"

date_modification_message
string[]

Messages explaining date adjustments due to plan limits.

Empty array if no modifications were needed. Contains human-readable messages when requested dates exceed plan's allowed lookback period.

Example: