Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string
required

Search query text

Minimum string length: 1
provider
enum<string>

Search provider to use

Available options:
google
max_results
integer

Max number of results to return

Required range: x <= 10
fetch_results
boolean

Whether to fetch full content of result pages

output
enum<string>[]

Output formats when fetching results (requires fetch_results)

Minimum array length: 1

Which output formats to return

Available options:
html,
markdown,
json,
screenshot
extract
object

Structured extraction config, requires json output

timeout_ms
integer

Max workflow duration, in ms

Required range: x <= 300000

Response

Search completed inline.

Common envelope every workflow endpoint (crawl, map, interact, search) returns: request/step metadata plus a kind-specific result.

id
string
required
request_id
string
required
kind
enum<string>
required
Available options:
crawl,
map,
interact,
search
mode
enum<string>
required
Available options:
inline
status
enum<string>
required
Available options:
completed,
partial,
failed
result
object
required

Kind-specific payload -- see the endpoint's example.

steps
object[]
diagnostics
object