DocsWorkflowsComponentsSearchsearch:web

search:web

Searches the web through the connection answering the search:web capability, so a workflow states the contract it needs and the connection decides which vendor serves it.

Options

Name	Type	Description
`query`	`string`	The search query
`connection`	`string`	The connection id to search with; empty resolves the only connection answering search:web
`page`	`int`	The result page number to fetch (0-based)
`raw`	`bool`	Also return the vendor's own answer boxes, knowledge panels and response body under raw, which ties this step to the vendor it was written against

Outputs

Name	Type	Description
`provider`	`string`	The vendor that answered the search
`query`	`string`	The original search query
`results`	`[]Match`	The organic search result list, ranked best first
↳ `title`	`string`	The result title
↳ `url`	`string`	The result address
↳ `snippet`	`string`	The result summary text
↳ `rank`	`int`	The result position, starting at 1
`output`	`string`	Search results rendered as markdown, useful for attaching to LLM prompts
`raw`	`RawWeb`	The vendor's own extras, present only when the step asked for them
↳ `engine`	`string`	The search engine the vendor ran the query on
↳ `parameters`	`map[string]string`	Vendor-specific search parameters echoed back
↳ `related`	`[]RelatedSearch`	Related search suggestions
↳ `query`	`string`
↳ `url`	`string`
↳ `knowledge`	`KnowledgePanel`	The knowledge panel or infobox
↳ `title`	`string`
↳ `description`	`string`
↳ `url`	`string`
↳ `image`	`string`
↳ `metadata`	`map[string]string`	E.g., "Born": "1961", "Author": "XYZ"
↳ `answer`	`InstantAnswer`	The direct answer or featured snippet
↳ `text`	`string`
↳ `source`	`string`
↳ `url`	`string`
↳ `total_results`	`int`	Estimated total number of results
↳ `credits`	`int`	Number of vendor credits consumed
↳ `next_page_token`	`string`	Token to fetch the next page of results
↳ `response`	`any`	The vendor's own response body

Edit or read the source on GitHub