Search the web

Ranked web results for a query through Exa — title, URL, a short snippet and the captioned photos found on each page. Charged as one flat call; a filtered search that returns nothing is retried once without its filters at no extra charge. A search scoped to a social platform is refused (400) with the social operations that read it.

Authorization

bearerAuth

AuthorizationBearer <token>

JWT token from authentication

In: header

Header Parameters

Endless-Api-Version?string

Pin the caller to an API major (1). Omit to accept the current version. A major this deployment cannot serve is refused with 400 unsupported_api_version.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organization_id*string

Match^org_

tool_call_id?|

The tool call behind this search, for the ledger. Every call that runs is billed, a repeated id too.

conversation_id?|

The chat this call belongs to, for cost attribution.

message_id?|

The chat turn this call belongs to, for cost attribution.

query*string

The search query, phrased as you'd type it into a search engine. For pictures, search the subject together with its qualifier in the language the sources use; appending 'photos' only ranks stock libraries.

Length1 <= length

num_results?integer

How many results to return (max 10).

Range1 <= value <= 10

Default5

category?string

Optional focus area — narrows results to one content type, so only set it when the query targets that exact type: 'news' for recent articles, 'publication' for academic work, 'financial report' for filings, 'personal site' for blogs. Leave it UNSET for how-tos, documentation, support articles, or general questions — a category will miss those and return nothing.

Value in

"publication"
"news"
"personal site"
"financial report"

time_range?string

Only return pages published within this window back from today.

Value in

"day"
"week"
"month"
"year"

include_domains?array<string>

Restrict results to these domains (e.g. ['nasa.gov']).

exclude_domains?array<string>

Drop results from these domains.

Response Body

`application/json`

curl -X POST "https://example.com/search" \  -H "Content-Type: application/json" \  -d '{    "organization_id": "string",    "query": "string"  }'

{  "summary": "string",  "results": [    {      "title": "string",      "url": "string",      "published_date": "string",      "author": "string",      "images": [        {          "url": "string",          "caption": "string"        }      ],      "snippet": "string"    }  ],  "credits_charged": 0}

Search the web

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

409application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`