Exa Search

POST/v1/api/exa/search

Run a neural semantic web search. Search the open web with a natural-language query and get back the most relevant results, optionally with page contents inline.

Request body

Call this sync operation at its vendor-qualified URL. The model identity is encoded in the path; only operation-specific input fields belong in the request body.

stringqueryrequired

The natural-language search query.

Optional<string>type

Search mode. auto lets Exa choose; the deep modes trade latency for higher-quality retrieval.

Allowed values: auto, fast, instant, deep-lite, deep, deep-reasoning

Default: auto

Optional<integer>numResults

Number of results to return.

Range: 1 to 100

Default: 10

Optional<string>category

Optional hint about the kind of pages to prioritize.

Allowed values: company, research paper, news, personal site, financial report, people

Optional<array<string>>includeDomains

Only return results from these domains.

Optional<array<string>>excludeDomains

Exclude results from these domains.

Optional<string>startPublishedDate

Only return results published on or after this ISO 8601 date.

Format: date-time

Optional<string>endPublishedDate

Only return results published on or before this ISO 8601 date.

Format: date-time

Optional<object>contents

Content options to return alongside each result.

Optional<boolean>contents.highlights

Return highlighted relevant snippets.

Optional<boolean>contents.summary

Return an AI-generated summary of the page.

Optional<boolean>contents.text

Return the full page text.

Optional<object>outputSchema

JSON Schema used to synthesize a structured output from the results.

Optional<string>systemPrompt

Instruction that guides how the structured output is generated.

Response Schema

A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

stringmodelrequired

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Contains exactly one item whose only field is data.

Optional<object | array>outputs[0].data

Operation-specific business payload. This reference uses an empty object when no safe example can be confirmed.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

API capabilities

array<string>capability_tagsrequired

Capabilities declared by the API registry.

Default: web-search

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"exa/search"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"exa/search"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"exa/search","outputs":[{"data":{}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"exa/search","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"exa/search","error":{"type":"upstream_error","message":"upstream request failed"}}

curl -X POST https://api.sandbase.ai/v1/api/exa/search \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{\n
  "query": "OpenAI Codex documentation"
}'

Response200 OK

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "status": "completed",
  "model": "exa/search",
  "outputs": [
    {
      "data": {}
    }
  ]
}