exa-labs/agent-skills

exa-search

Call Exa Search directly with cURL or raw HTTP.

View source
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

Exa Search

Requires API key: Get one at https://dashboard.exa.ai/api-keys Header: x-api-key: $EXA_API_KEY

Use POST https://api.exa.ai/search for semantic web retrieval, ranked results, and optional result-level extraction in one raw HTTP call. Start with type: "auto" for general retrieval. Add contents only when the caller needs page text, highlights, summaries, freshness-controlled crawling, subpages, or extracted links.

Quick Start (cURL)

Basic search

bash
curl -sS -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "latest developments in LLMs",
    "type": "auto",
    "numResults": 10
  }'

Search with highlights

bash
curl -sS -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "latest developments in LLMs",
    "type": "auto",
    "numResults": 5,
    "contents": {
      "highlights": true
    }
  }'

With filters and freshness

bash
curl -sS -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "AI regulation policy updates",
    "type": "auto",
    "category": "news",
    "numResults": 10,
    "includeDomains": ["reuters.com", "bbc.com"],
    "startPublishedDate": "2025-01-01",
    "contents": {
      "text": {
        "maxCharacters": 2000
      },
      "maxAgeHours": 24,
      "livecrawlTimeout": 12000
    }
  }'

Deep search

bash
curl -sS -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "map the major technical and commercial tradeoffs in sodium-ion batteries for grid storage",
    "type": "deep",
    "numResults": 8
  }'

Endpoint

text
POST https://api.exa.ai/search

Authentication: x-api-key: <API_KEY> header. Exa also accepts Authorization: Bearer <API_KEY>, but prefer x-api-key in cURL examples for consistency.

Use this endpoint when the agent needs search results. If the agent already has URLs and only needs extraction, use POST /contents instead.

Parameters

Core request parameters

ParameterTypeRequiredDefaultDescription
querystringYes-Natural-language search query. Long, semantically rich descriptions work well.
typestringNoautoSearch method: auto, fast, instant, deep-lite, deep, or deep-reasoning.
numResultsintegerNo10Number of results to return. Use small values for agent loops; maximum is 100.
categorystringNo-Specialized result type: company, people, research paper, news, personal site, or financial report.
includeDomainsstring[]No-Only return results from these domains, paths, or wildcard patterns. Max 1200.
excludeDomainsstring[]No-Exclude these domains, paths, or wildcard patterns. Max 1200.
startPublishedDatestringNo-ISO 8601 lower bound for result publication date.
endPublishedDatestringNo-ISO 8601 upper bound for result publication date.
userLocationstringNo-Two-letter ISO country code such as US or GB.
moderationbooleanNofalseFilter unsafe content from results.
additionalQueriesstring[]No-Extra query variants for deep-search variants. Use alongside the main query.
systemPromptstringNo-Instructions for synthesized output and deep-search planning, such as source preferences.
outputSchemaobjectNo-JSON Schema controlling output.content. Adds synthesized output and grounding.
streambooleanNofalseIf true, returns SSE instead of a single JSON response.
compliancestringNo-Enterprise-only compliance mode, such as hipaa, when enabled for the account.

Content parameters nested under contents

On /search, text, highlights, and summary must be nested under contents.

ParameterTypeRequiredDefaultDescription
contents.textboolean or objectNo-Return full page text as markdown. Object form supports maxCharacters, includeHtmlTags, verbosity, includeSections, and excludeSections.
contents.highlightsboolean or objectNo-Return query-relevant excerpts. Prefer true for agent workflows unless a fixed character budget is required.
contents.summaryboolean or objectNo-Return per-result LLM summaries. Use sparingly because each result adds synthesis work.
contents.maxAgeHoursintegerNo-Freshness control. 0 always live crawls; -1 uses cache only; omit for default cache-first behavior with crawl fallback.
contents.livecrawlTimeoutintegerNo10000Timeout for live crawling in milliseconds. Use 10000 to 15000 for most freshness-sensitive calls.
contents.subpagesintegerNo0Number of linked subpages to crawl per result.
contents.subpageTargetstring or string[]No-Terms used to prioritize which subpages matter, such as ["api", "pricing"].
contents.extras.linksintegerNo0Number of links to extract from each result page.
contents.extras.imageLinksintegerNo0Number of image URLs to extract from each result page.

Text object options

ParameterTypeDefaultDescription
maxCharactersinteger-Character limit for returned text. Use this instead of tokensNum.
includeHtmlTagsbooleanfalsePreserve HTML tags in output.
verbositystringcompactcompact, standard, or full. Pair fresh section-aware extraction with contents.maxAgeHours: 0.
includeSectionsstring[]-Only include selected sections: header, navigation, banner, body, sidebar, footer, metadata.
excludeSectionsstring[]-Exclude selected sections from the same section list.

Highlights object options

Prefer contents.highlights: true for the highest-quality default. Only use object form when the agent needs a custom focus or budget.

ParameterTypeDefaultDescription
querystring-Custom query guiding which excerpts are returned.
maxCharactersinteger-Cap highlight characters per URL. Omit unless the caller has a strict budget.

Summary object options

ParameterTypeDefaultDescription
querystring-Custom query for the summary.
schemaobject-JSON Schema for structured per-result summaries.

Search Types

Search type controls the retrieval and synthesis mode. Pick the mode for the workflow, not just the output format. outputSchema can be used with any search type; use deeper modes when the search process itself needs more planning, synthesis, or reasoning.

TypeBest forTradeoff
autoGeneral default search and most new integrationsBalances speed and quality without requiring the caller to tune retrieval strategy.
fastLow-latency agent loops and product pathsFaster than auto; use when responsiveness matters more than maximum reasoning depth.
instantReal-time UI, chat, voice, and autocomplete-style pathsLowest latency path; use for quick retrieval rather than deep synthesis.
deep-liteLightweight research or synthesisAdds more planning and synthesis than auto while staying lighter than full deep.
deepMulti-step research, comparisons, and synthesis-heavy retrievalHigher latency; better when the query needs exploration across several sources.
deep-reasoningHard research tasks with high ambiguity or complex tradeoffsHighest latency and reasoning depth.

Use auto unless latency or reasoning depth is the primary constraint. Use fast or instant for time-sensitive calls. Use deep, deep-lite, or deep-reasoning when the query needs multi-step source discovery, comparison, or synthesis.

Mode-only examples

json
{
  "query": "recent product launches from major AI chip companies",
  "type": "fast",
  "numResults": 5
}
json
{
  "query": "compare competing explanations for the recent rise in grid-scale battery deployments",
  "type": "deep",
  "numResults": 8
}

Structured Output

Use systemPrompt for behavior and outputSchema for shape.

bash
curl -sS -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "compare the latest frontier AI model releases",
    "type": "deep",
    "systemPrompt": "Prefer official sources and avoid duplicate results.",
    "outputSchema": {
      "type": "object",
      "properties": {
        "models": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": { "type": "string" },
              "notable_claims": {
                "type": "array",
                "items": { "type": "string" }
              }
            },
            "required": ["name", "notable_claims"]
          }
        }
      },
      "required": ["models"]
    },
    "contents": {
      "highlights": true
    }
  }'

Keep schemas compact and bounded. Do not add citation fields to the schema; grounding is returned separately in output.grounding.

Streaming

Streaming applies to synthesized output, so include outputSchema along with -N, Accept: text/event-stream, and stream: true. Without outputSchema, the endpoint returns the normal JSON search response even when stream is true.

bash
curl -sS -N -X POST "https://api.exa.ai/search" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -H "x-api-key: $EXA_API_KEY" \
  -d '{
    "query": "recent grid-scale battery deployments",
    "type": "deep",
    "stream": true,
    "outputSchema": {
      "type": "object",
      "properties": {
        "summary": { "type": "string" }
      },
      "required": ["summary"]
    },
    "contents": {
      "highlights": true
    }
  }'

Treat streaming as SSE rather than JSON. Each data: frame contains an OpenAI-compatible chat completion chunk; read partial text from choices[0].delta.content and handle completion or error frames defensively.

Response Fields

FieldTypeDescription
requestIdstringUnique request identifier.
resultsarrayRanked result objects.
results[].titlestringPage title.
results[].urlstringPage URL.
results[].publishedDatestring or nullEstimated publication date when available.
results[].authorstring or nullAuthor when available.
results[].textstringReturned when contents.text is requested.
results[].highlightsstring[]Returned when contents.highlights is requested.
results[].highlightScoresnumber[]Similarity scores for highlights.
results[].summarystringReturned when contents.summary is requested.
results[].subpagesarrayNested result objects from subpage crawling.
results[].extras.linksstring[]Extracted links when requested.
output.contentstring or objectSynthesized output when outputSchema is provided.
output.groundingarrayCitations and confidence labels for synthesized fields.
costDollars.totalnumberTotal request cost when returned.
searchTimenumberSearch latency when returned.

Critical Pitfalls

  • Keep text, highlights, and summary inside contents on /search.
  • Do not send top-level text, highlights, or summary; that shape belongs to /contents.
  • Do not send tokensNum; use contents.text.maxCharacters to cap extracted text.
  • Do not use useAutoprompt, numSentences, or highlightsPerUrl in new requests.
  • Use contents.maxAgeHours instead of livecrawl.
  • Use documented categories only: company, people, research paper, news, personal site, and financial report.
  • Avoid invalid category/filter combinations. company and people do not support startPublishedDate or endPublishedDate. company supports excludeDomains; people does not, and people only accepts LinkedIn domains in includeDomains.
  • Pick one of contents.highlights, contents.text, or contents.summary by default. Stack modes only when the caller truly needs multiple views of each page.
  • Expect SSE only when stream: true is paired with outputSchema; otherwise /search returns its normal JSON response.
from this repository

More skills

All skills
exa-labs
Community

build-with-exa

Build applications and agents with Exa's API: search, contents extraction, answer, Agent API, monitors, websets, OpenAI-compatible endpoints, and exa-py/exa-js SDKs. Use when choosing Exa endpoints, writing Exa API calls, integrating semantic web search or research into products, or debugging Exa request shapes.

installs
1
GitHub stars
45
Updated
Sep 3
exa-labs
Community

company-research

Company research using Exa. Finds company info, competitors, news, financials, LinkedIn profiles, builds company lists. Use when researching companies, doing competitor analysis, market research, or building company lists.

installs
1
GitHub stars
45
Updated
Sep 3
exa-labs
Community

exa-contents

Call Exa Contents directly with cURL or raw HTTP. Use when an agent already has URLs and needs POST /contents without an SDK for extracted text, highlights, summaries, links, image links, subpages, freshness-controlled crawling, or per-URL status handling.

installs
1
GitHub stars
45
Updated
Sep 3
exa-labs
Community

lead-generation

Generate enriched lead lists using Exa Agent. Finds companies matching an ICP, enriches with signals/news/scores, and outputs CSV. Use when generating leads, building prospect lists, finding companies to sell to, doing outbound research, or ICP-based company discovery. Triggers on "leads", "lead gen", "prospect list", "find companies", "ICP", "outbound list".

installs
1
GitHub stars
45
Updated
Sep 3