Tasks
Web Search
Searches the web and returns relevant results with page content. Useful for research, enrichment, AI prompts, and external information gathering.
Basic usage
Parameters
search_query required string
The search query to run.
search_type string
The type of search to perform. One of:
auto— automatically selects the best search strategydeep— thorough search, best for comprehensive resultslite— low-latency search, best for chat, voice agents, and simple lookups. Serves cached content only
fast and instant are legacy values and run as lite.
lite does not support ai_summary. When result_options.ai_summary is enabled, a lite search runs as auto instead.
Default: auto
filters Object
Optional filters to narrow down search results.
Show child attributes
include_domains Array.<string>
Only return results from these domains. Example: ["bbc.com", "reuters.com"]
exclude_domains Array.<string>
Exclude results from these domains. Example: ["reddit.com"]
start_published_date string
Only return results published after this date.
Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:mm, or ISO 8601.
end_published_date string
Only return results published before this date.
Accepted formats: YYYY-MM-DD, YYYY-MM-DDTHH:mm, or ISO 8601.
result_options Object
Options to control the result set.
Show child attributes
result_count number
The number of results to return. Must be between 1 and 100.
Default: 10
ai_summary Object
When enabled, each result will include an AI-generated summary based on the provided prompt.
Show child attributes
enabled required boolean
Whether to enable AI summary generation per result.
prompt required string
The prompt used to generate the summary for each result. Required when enabled is true.
highlights Object
When enabled, each result will include the most relevant passages from the page. Highlights use far fewer tokens than full page text, which makes them well suited to AI prompts.
Show child attributes
enabled required boolean
Whether to return highlights per result.
query string
Steers which passages are selected, for example "pricing and plans" to focus on pricing details.
max_characters number
The maximum number of characters of highlights to return per result. Must be between 1 and 1000000.
full_text boolean
Controls whether the extracted page text (up to 10,000 characters) is included in each result.
true— always include page text, alongside highlights or AI summariesfalse— never include page text- not set — page text is included only when neither
highlightsnorai_summaryis enabled
Result
Properties
search_results Array.<Object>
Array of search result objects.
Show child attributes
id string
The unique identifier for the result (typically the URL).
title string
The title of the page.
url string
The URL of the page.
publishedDate string
The published date of the page in ISO 8601 format, if available.
author string
The author of the page, if available.
text string
The extracted text content of the page. See result_options.full_text for when this is present.
image string
The URL of the page's primary image (e.g. Open Graph image), if available.
favicon string
The URL of the page's favicon, if available.
summary string
AI-generated summary for this result. Only present when result_options.ai_summary.enabled is true.
highlights Array.<string>
The most relevant passages from the page. Only present when result_options.highlights.enabled is true.
highlightScores Array.<number>
The relevance score of each highlight, in the same order as highlights. Only present when result_options.highlights.enabled is true.
Examples
Search with domain filter
Only return results from specific AI-focused publications.
Search with date range
Only return results published within a specific time window.
Search with AI summary
Return results with an AI-generated summary per page, tailored to your use case. Set full_text to true to also include the page text.
Result:
Search with highlights
Return only the most relevant passages from each page, using far fewer tokens than full page text.
Result: