> ## Documentation Index > Fetch the complete documentation index at: https://exa.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Search > The search endpoint lets you search the web and extract contents from the results. Create a key in the dashboard. New accounts start with free credits. ## OpenAPI ````yaml post /search openapi: 3.1.0 info: title: Exa Public API version: 2.0.0 servers: - url: https://api.exa.ai security: - apiKey: [] - bearer: [] tags: [] paths: /search: post: summary: Search description: >- Perform a search with an Exa prompt-engineered query and retrieve a list of relevant results. Optionally get contents. operationId: search requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequest' responses: '200': description: OK headers: x-request-id: $ref: '#/components/headers/XRequestId' x-exa-queued: $ref: '#/components/headers/XExaQueued' x-exa-queue-ms: $ref: '#/components/headers/XExaQueueMs' content: application/json: example: requestId: b5947044c4b78efa9552a7c89b306d95 results: - title: A Comprehensive Overview of Large Language Models url: https://arxiv.org/pdf/2307.06435.pdf publishedDate: '2023-11-16T01:36:32.547Z' author: >- Humza Naveed, University of Engineering and Technology (UET), Lahore, Pakistan id: https://arxiv.org/abs/2307.06435 image: https://arxiv.org/pdf/2307.06435.pdf/page_1.png favicon: https://arxiv.org/favicon.ico text: >- Abstract Large Language Models (LLMs) have recently demonstrated remarkable capabilities... highlights: - Such requirements have limited their adoption... summary: >- This overview paper on Large Language Models (LLMs) highlights key developments... resolvedSearchType: neural costDollars: total: 0.007 search: neural: 0.007 schema: $ref: '#/components/schemas/SearchResponse' text/event-stream: schema: $ref: '#/components/schemas/SearchStreamChunk' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': description: >- Payment required. For API-key requests this is the standard error envelope (out of credits or a budget exceeded). On x402-priced endpoints, requests without an API key instead receive an x402 payment challenge with tag `X402_PAYMENT_REQUIRED`: the envelope extended with x402 payment metadata (`x402Version`, `resource`, `accepts`, and optional `extensions`) describing how to pay for the request. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/X402PaymentChallenge' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' components: schemas: SearchRequest: type: object properties: includeDomains: anyOf: - maxItems: 1200 type: array items: type: string description: >- List of domains or domain paths to include in the search. Each entry can be a hostname (for example, `example.com`), a hostname with a path prefix (for example, `example.com/docs`), or a wildcard subdomain (for example, `*.example.com`). If specified, results will only come from the matching domains or paths. Use this parameter for domain or path filtering instead of adding a `site:` operator to the query. example: - arxiv.org - exa.ai/blog - type: 'null' excludeDomains: anyOf: - maxItems: 1200 type: array items: type: string description: >- List of domains or domain paths to exclude from search results. Each entry can be a hostname (for example, `example.com`), a hostname with a path prefix (for example, `example.com/docs`), or a wildcard subdomain (for example, `*.example.com`). If specified, no results will be returned from the matching domains or paths. Use this parameter for domain or path filtering instead of adding a `site:` operator to the query. example: - docs.python.org/3 - type: 'null' startCrawlDate: anyOf: - type: string description: >- Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format. example: '2023-01-01T00:00:00.000Z' format: date-time deprecated: true - type: 'null' endCrawlDate: anyOf: - type: string description: >- Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format. example: '2023-12-31T00:00:00.000Z' format: date-time deprecated: true - type: 'null' startPublishedDate: anyOf: - type: string description: >- Only links with a published date after this will be returned. Must be specified in ISO 8601 format. example: '2023-01-01T00:00:00.000Z' format: date-time - type: 'null' endPublishedDate: anyOf: - type: string description: >- Only links with a published date before this will be returned. Must be specified in ISO 8601 format. example: '2023-12-31T00:00:00.000Z' format: date-time - type: 'null' numResults: anyOf: - type: integer minimum: 1 maximum: 100 description: >- Number of results to return. Limits vary by search type. The maximum public limit is 100 results. Contact sales (hello@exa.ai) to discuss higher limits. example: 10 default: 10 - type: 'null' context: anyOf: - description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. deprecated: true oneOf: - type: boolean description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. example: true deprecated: true - type: object properties: maxCharacters: type: integer minimum: 1 maximum: 10000 description: >- Deprecated. Maximum character limit for the context string. Maximum supported value is 10000. example: 10000 description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. deprecated: true - type: 'null' moderation: anyOf: - type: boolean description: >- Enable content moderation to filter unsafe content from search results. example: true default: false - type: 'null' contents: anyOf: - $ref: '#/components/schemas/ContentsOptions' description: >- Content options for text, highlights, summary, extras, and freshness controls. - type: 'null' query: type: string minLength: 1 description: The query string for the search. example: Latest developments in LLM capabilities additionalQueries: anyOf: - minItems: 1 maxItems: 10 type: array items: type: string description: >- Additional query variations for deep-search variants. Only works with a deep-search type. When provided, these queries are used alongside the main query for broader results. example: - LLM advancements - large language model progress - type: 'null' type: anyOf: - type: string enum: - instant - fast - auto - deep-lite - deep - deep-reasoning description: >- The search mode to use. `auto` (default) is a balanced mode that optimizes for both quality and speed and is recommended for most applications. `fast` returns high-quality results with reduced latency, making it a good fit for user-facing search and interactive workflows. `instant` is optimized for minimum response time, trading some search depth for speed in real-time experiences such as chat, voice agents, and autocomplete. `deep-lite` performs lightweight research with synthesized results and a consistent 4-second latency, lower than full deep search. `deep` conducts comprehensive multi-step research with synthesis, while `deep-reasoning` adds stronger reasoning for complex analysis and decision-making tasks. example: auto default: auto - type: 'null' category: anyOf: - type: string enum: - company - publication - news - personal site - financial report - people description: >- A data category to focus on. Known categories include `company`, `publication`, `news`, `personal site`, `financial report`, and `people`. Other strings are accepted and used as category hints for search. The `people` and `company` categories have improved quality for finding people profiles and company pages. The `publication` category surfaces scholarly publications such as research papers, preprints, and journal articles, with structured metadata like authors, venue, and citations. Note: The `company` and `people` categories only support a limited set of filters. The following parameters are NOT supported for these categories: `startPublishedDate`, `endPublishedDate`, `excludeDomains`. Using unsupported parameters will result in a 400 error. example: publication - type: 'null' userLocation: anyOf: - type: string description: The two-letter ISO country code of the user, e.g. US. example: US - type: 'null' compliance: anyOf: - type: string enum: - hipaa description: >- Enterprise-only compliance mode. Set to `hipaa` for HIPAA mode. Requires cache-only retrieval with supported parameters. See the HIPAA docs for details. example: hipaa - type: 'null' outputSchema: anyOf: - oneOf: - $ref: '#/components/schemas/OutputSchemaText' - $ref: '#/components/schemas/OutputSchemaObject' description: >- JSON schema for synthesized output. Supported root types are "text" and "object". When provided, the response includes an output object whose content matches this schema. Works with every search type and adds about 2 seconds of synthesis latency on top of the selected search type. type: object discriminator: propertyName: type mapping: text: $ref: '#/components/schemas/OutputSchemaText' object: $ref: '#/components/schemas/OutputSchemaObject' - type: 'null' systemPrompt: anyOf: - type: string description: >- Additional instructions that guide generated output or agent behavior. Use this for source preferences, novelty constraints, duplication constraints, or other behavior guidance. example: Prefer official sources and avoid duplicate results. - type: 'null' stream: anyOf: - type: boolean description: >- Requests server-sent events for synthesized output streaming. Streaming is currently used only when outputSchema is provided; otherwise the endpoint returns the normal JSON search response. default: false - type: 'null' required: - query SearchResponse: oneOf: - $ref: '#/components/schemas/SearchSynthesisResponse' - $ref: '#/components/schemas/SearchResultsResponse' SearchStreamChunk: oneOf: - $ref: '#/components/schemas/SearchStreamTextDeltaChunkOutput' - $ref: '#/components/schemas/SearchStreamGroundingChunkOutput' - $ref: '#/components/schemas/SearchStreamResultsChunkOutput' - $ref: '#/components/schemas/SearchStreamResetChunkOutput' - $ref: '#/components/schemas/SearchStreamDoneChunkOutput' - $ref: '#/components/schemas/SearchStreamErrorChunkOutput' description: >- Schema for each JSON payload emitted in a `/search` server-sent event stream. Each event is emitted as `data: ` and the stream terminates with `data: [DONE]`, which is not represented by this JSON schema. type: object discriminator: propertyName: type mapping: text-delta: $ref: '#/components/schemas/SearchStreamTextDeltaChunkOutput' grounding: $ref: '#/components/schemas/SearchStreamGroundingChunkOutput' results: $ref: '#/components/schemas/SearchStreamResultsChunkOutput' stream-reset: $ref: '#/components/schemas/SearchStreamResetChunkOutput' done: $ref: '#/components/schemas/SearchStreamDoneChunkOutput' error: $ref: '#/components/schemas/SearchStreamErrorChunkOutput' ErrorResponse: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 error: type: string description: Human-readable message describing the error. example: Invalid API key tag: type: string description: >- Machine-readable error tag identifying the failure. The set of tags is open-ended: new tags may be added at any time, so treat unrecognized tags as a generic error of the response's HTTP status. Known tags are listed as examples. examples: - DEFAULT_ERROR - INTERNAL_ERROR - INVALID_API_KEY - INVALID_REQUEST - INVALID_REQUEST_BODY - INVALID_REQUEST_QUERY - INVALID_JSON_SCHEMA - INVALID_NUM_RESULTS - NUM_RESULTS_EXCEEDED - NO_MORE_CREDITS - API_KEY_BUDGET_EXCEEDED - TEAM_BUDGET_EXCEEDED - NO_CONTENT_FOUND - PROHIBITED_CONTENT - INSUFFICIENT_SCOPE - UNABLE_TO_GENERATE_RESPONSE - UNSUPPORTED_PUBLICATION_INCLUDE_FILTER - SUBPAGES_LIMIT_EXCEEDED - FEATURE_DISABLED - INVALID_URLS - FETCH_DOCUMENT_ERROR - TEAM_BLOCKED - NOT_FOUND - RATE_LIMIT_EXCEEDED required: - requestId - error - tag additionalProperties: false description: Standard error envelope returned by the Exa API for failed requests. X402PaymentChallenge: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 error: type: string description: Human-readable message describing the error. example: Payment required to access this resource tag: type: string description: >- Machine-readable error tag identifying the failure. The set of tags is open-ended: new tags may be added at any time, so treat unrecognized tags as a generic error of the response's HTTP status. Known tags are listed as examples. examples: - DEFAULT_ERROR - INTERNAL_ERROR - INVALID_API_KEY - INVALID_REQUEST - INVALID_REQUEST_BODY - INVALID_REQUEST_QUERY - INVALID_JSON_SCHEMA - INVALID_NUM_RESULTS - NUM_RESULTS_EXCEEDED - NO_MORE_CREDITS - API_KEY_BUDGET_EXCEEDED - TEAM_BUDGET_EXCEEDED - NO_CONTENT_FOUND - PROHIBITED_CONTENT - INSUFFICIENT_SCOPE - UNABLE_TO_GENERATE_RESPONSE - UNSUPPORTED_PUBLICATION_INCLUDE_FILTER - SUBPAGES_LIMIT_EXCEEDED - FEATURE_DISABLED - INVALID_URLS - FETCH_DOCUMENT_ERROR - TEAM_BLOCKED - NOT_FOUND - RATE_LIMIT_EXCEEDED x402Version: type: number description: Version of the x402 protocol used to build this challenge. example: 2 resource: type: object properties: url: type: string description: URL of the priced resource being requested. description: type: string description: Human-readable resource description. mimeType: type: string description: MIME type of the priced resource. required: - url - description - mimeType additionalProperties: false description: The priced resource this challenge applies to. accepts: type: array items: type: object propertyNames: type: string additionalProperties: {} description: >- An accepted x402 payment requirement (scheme, network, amount, payTo, asset, maxTimeoutSeconds, and scheme-specific `extra` fields). description: Payment requirements the server accepts, one per supported rail. extensions: description: >- Optional x402 protocol extensions (e.g. Bazaar or AgentKit discovery metadata). type: object propertyNames: type: string additionalProperties: {} required: - requestId - error - tag - x402Version - resource - accepts additionalProperties: false description: >- x402 payment challenge: the standard error envelope extended with x402 payment metadata. ContentsOptions: type: object properties: text: anyOf: - description: Text extraction options for each result. oneOf: - type: boolean title: Simple text retrieval description: >- If true, returns full page text with default settings. If false, disables text return. default: false - type: object properties: maxCharacters: anyOf: - type: integer minimum: 1 maximum: 10000 description: >- Maximum character limit for the full page text. Useful for controlling response size and API costs. Maximum supported value is 10000. example: 1000 - type: 'null' includeHtmlTags: anyOf: - type: boolean description: >- If true, include lightweight HTML tags in returned text instead of plain markdown-style text. Use maxAgeHours: 0 when you need this applied to freshly fetched content. example: false default: false - type: 'null' verbosity: anyOf: - type: string enum: - compact - standard - full description: >- Controls text rendering verbosity. compact focuses on main content, standard includes more surrounding page context, and full requests the most complete rendered text. Some pages may produce identical standard and full output. Use maxAgeHours: 0 when you need this applied to freshly fetched content. example: standard default: compact - type: 'null' includeSections: anyOf: - type: array items: type: string enum: - header - navigation - banner - body - sidebar - footer - metadata description: >- Best-effort. Only include content classified into these semantic page sections. Section classification may be unavailable or incomplete for some pages; validate output if strict filtering is required. Use maxAgeHours: 0 when you need this applied to freshly fetched content. example: - body - header - type: 'null' excludeSections: anyOf: - type: array items: type: string enum: - header - navigation - banner - body - sidebar - footer - metadata description: >- Exclude content classified into these semantic page sections. Section classification is best-effort. Use maxAgeHours: 0 when you need this applied to freshly fetched content. example: - navigation - footer - sidebar - type: 'null' title: Advanced text options description: >- Advanced options for controlling text extraction. Use this when you need to limit text length or include HTML structure. - type: 'null' highlights: anyOf: - description: >- Text snippets the LLM identifies as most relevant from each page. oneOf: - type: boolean title: Simple highlights retrieval description: >- If true, returns highlights with default settings. If false, disables highlights. default: false - type: object properties: query: anyOf: - type: string description: >- Custom query that guides which highlights the LLM picks. example: Key advancements - type: 'null' verbosity: anyOf: - type: string enum: - low - medium - high description: >- Preset highlight length: `low`, `medium`, and `high` allocate progressively larger token budgets for the returned highlights. With highlights.dynamic, the preset sets a single shared budget across the whole result set instead of a per-URL budget. Exact budgets are tuned by Exa and may change. Not compatible with maxCharacters or numSentences. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `verbosity` without it are rejected. example: medium x-exa-lifecycle: beta x-exa-beta-flag: dynamic-highlights-2026-08-28 x-mint: post: - Beta - type: 'null' dynamic: anyOf: - type: boolean description: >- Enable Dynamic Highlights (research preview): considers all results together and allocates a single shared context budget across the result set instead of a per-document budget. Not compatible with maxCharacters. Beta: requires the `Exa-Beta: dynamic-highlights-2026-08-28` request header; requests setting `dynamic` without it are rejected. example: true x-exa-lifecycle: beta x-exa-beta-flag: dynamic-highlights-2026-08-28 x-mint: post: - Beta - type: 'null' maxCharacters: anyOf: - type: integer minimum: 1 maximum: 10000 description: >- Maximum number of characters to return for highlights. Controls the total length of highlight text returned per URL. Maximum supported value is 10000. Not compatible with highlights.dynamic. example: 2000 - type: 'null' numSentences: anyOf: - type: integer minimum: 1 description: >- Deprecated and will be removed in a future release. Currently mapped to a character budget of about 1333 characters per sentence. Pass highlights: true for default highlights, or { query } to guide selection with your own query. example: 1 deprecated: true - type: 'null' highlightsPerUrl: anyOf: - type: integer minimum: 1 description: >- Deprecated and will be removed in a future release. Currently ignored. Pass highlights: true for default highlights, or { query } to guide selection with your own query. example: 1 deprecated: true - type: 'null' title: Advanced highlights options description: >- Advanced options for steering highlight extraction. Pass highlights: true for the highest-quality default; supply this object only when you need to guide selection with your own query. - type: 'null' summary: anyOf: - type: object properties: query: anyOf: - type: string description: Custom query for the LLM-generated summary. example: Main developments - type: 'null' schema: anyOf: - type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' description: >- JSON schema for structured output from summary. See https://json-schema.org/overview/what-is-jsonschema for JSON Schema documentation. example: $schema: http://json-schema.org/draft-07/schema# title: Title type: object properties: Property 1: type: string description: Description Property 2: type: string enum: - option 1 - option 2 - option 3 description: Description required: - Property 1 - type: 'null' description: Summary of the webpage. - type: 'null' extras: anyOf: - type: object properties: links: anyOf: - type: integer minimum: 0 maximum: 1000 description: Number of URLs to return from each webpage. example: 1 default: 0 - type: 'null' imageLinks: anyOf: - type: integer minimum: 0 maximum: 1000 description: Number of images to return for each result. example: 1 default: 0 - type: 'null' richImageLinks: anyOf: - type: integer minimum: 0 maximum: 1000 description: Number of rich image links to return for each result. default: 0 - type: 'null' richLinks: anyOf: - type: integer minimum: 0 maximum: 1000 description: Number of rich links to return for each result. default: 0 - type: 'null' codeBlocks: anyOf: - type: integer minimum: 0 maximum: 1000 description: Number of code blocks to return for each result. default: 0 - type: 'null' description: Extra parameters to pass. - type: 'null' context: anyOf: - description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. deprecated: true oneOf: - type: boolean description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. example: true deprecated: true - type: object properties: maxCharacters: type: integer minimum: 1 maximum: 10000 description: >- Deprecated. Maximum character limit for the context string. Maximum supported value is 10000. example: 10000 description: >- Deprecated: Use highlights or text instead. Returns page contents as a combined context string. deprecated: true - type: 'null' livecrawl: anyOf: - type: string enum: - never - always - fallback - preferred description: >- Deprecated: Use maxAgeHours instead for content freshness control. livecrawl does not guarantee freshly fetched parser output and may be served according to server freshness policy. Do not send livecrawl and maxAgeHours together. example: preferred deprecated: true - type: 'null' livecrawlTimeout: anyOf: - type: integer exclusiveMinimum: 0 maximum: 90000 description: The timeout for livecrawling in milliseconds. example: 1000 default: 10000 - type: 'null' maxAgeHours: anyOf: - type: integer minimum: -1 maximum: 720 description: >- Maximum age of cached content in hours. Positive values use cached content if it is less than this many hours old; 0 fetches fresh content and is the supported way to apply text rendering options to newly fetched pages; -1 always uses cache; omitted uses fallback fetching when cached content is unavailable. Maximum supported value is 720 hours. example: 24 - type: 'null' subpages: anyOf: - type: integer minimum: 0 maximum: 100 description: >- The number of subpages to crawl. The actual number crawled may be limited by system constraints. example: 1 default: 0 - type: 'null' subpageTarget: anyOf: - description: >- Term to find specific subpages of search results. Can be a single string or an array of strings. example: sources oneOf: - type: string minLength: 1 maxLength: 100 - minItems: 0 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 100 - type: 'null' OutputSchemaText: type: object properties: type: type: string const: text description: type: string required: - type OutputSchemaObject: type: object properties: type: type: string const: object description: type: string properties: type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' required: type: array items: type: string additionalProperties: type: boolean required: - type additionalProperties: $ref: '#/components/schemas/JsonValue' SearchSynthesisResponse: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 results: type: array items: $ref: '#/components/schemas/SearchResultOutput' description: >- A list of search results containing title, URL, published date, and author. resolvedSearchType: description: >- Deprecated legacy field. Current production responses may return an empty string; clients should not branch on this value. example: '' deprecated: true type: string context: type: string description: >- Deprecated. Combined context string from search results. Use highlights or text instead. deprecated: true costDollars: $ref: '#/components/schemas/CostDollarsOutput' searchTime: type: number description: >- Server-side processing time in milliseconds, measured at the gateway. Covers retrieval but may exclude later phases such as structured output synthesis, so it can be lower than end-to-end request latency. example: 312.4 output: $ref: '#/components/schemas/SearchSynthesisOutputOutput' required: - results - output additionalProperties: false SearchResultsResponse: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 results: type: array items: $ref: '#/components/schemas/SearchResultOutput' description: >- A list of search results containing title, URL, published date, and author. resolvedSearchType: description: >- Deprecated legacy field. Current production responses may return an empty string; clients should not branch on this value. example: '' deprecated: true type: string context: type: string description: >- Deprecated. Combined context string from search results. Use highlights or text instead. deprecated: true costDollars: $ref: '#/components/schemas/CostDollarsOutput' searchTime: type: number description: >- Server-side processing time in milliseconds, measured at the gateway. Covers retrieval but may exclude later phases such as structured output synthesis, so it can be lower than end-to-end request latency. example: 312.4 required: - results additionalProperties: false SearchStreamTextDeltaChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: text-delta delta: type: string choices: type: array items: type: object properties: index: type: integer minimum: 0 delta: type: object properties: role: type: string const: assistant content: type: string citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. id: type: string required: - url - title - id additionalProperties: false additionalProperties: false finish_reason: oneOf: - type: string const: stop - type: 'null' required: - index - delta - finish_reason additionalProperties: false required: - type - delta additionalProperties: false SearchStreamGroundingChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: grounding grounding: type: array items: type: object properties: field: type: string description: >- Field path in output.content, for example content or companies[0].funding. citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. required: - url - title additionalProperties: false description: Sources supporting this output field. confidence: type: string enum: - low - medium - high description: Model-reported reliability for this field. required: - field - citations - confidence additionalProperties: false description: Field-level grounding for synthesized output. citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. id: type: string required: - url - title - id additionalProperties: false choices: type: array items: type: object properties: index: type: integer minimum: 0 delta: type: object properties: role: type: string const: assistant content: type: string citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. id: type: string required: - url - title - id additionalProperties: false additionalProperties: false finish_reason: oneOf: - type: string const: stop - type: 'null' required: - index - delta - finish_reason additionalProperties: false required: - type - grounding additionalProperties: false SearchStreamResultsChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: results results: type: array items: $ref: '#/components/schemas/SearchResultOutput' required: - type - results additionalProperties: false SearchStreamResetChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: stream-reset streamReset: type: boolean const: true required: - type - streamReset additionalProperties: false SearchStreamDoneChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: done output: anyOf: - $ref: '#/components/schemas/SearchSynthesisOutputOutput' - type: 'null' searchTime: type: number description: >- Server-side processing time in milliseconds, measured at the gateway. Covers retrieval but may exclude later phases such as structured output synthesis, so it can be lower than end-to-end request latency. example: 312.4 costDollars: $ref: '#/components/schemas/CostDollarsOutput' choices: type: array items: type: object properties: index: type: integer minimum: 0 delta: type: object properties: role: type: string const: assistant content: type: string citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. id: type: string required: - url - title - id additionalProperties: false additionalProperties: false finish_reason: oneOf: - type: string const: stop - type: 'null' required: - index - delta - finish_reason additionalProperties: false required: - type - output - searchTime additionalProperties: false SearchStreamErrorChunkOutput: type: object properties: requestId: type: string description: Unique identifier for the request. example: b5947044c4b78efa9552a7c89b306d95 type: type: string const: error error: type: object properties: message: type: string required: - message additionalProperties: false required: - type - error additionalProperties: false JsonValue: description: Any JSON value. oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' SearchResultOutput: type: object properties: title: type: string description: The title of the search result. example: A Comprehensive Overview of Large Language Models url: type: string description: The URL of the search result. example: https://arxiv.org/pdf/2307.06435.pdf format: uri publishedDate: description: >- An estimate of the creation date, from parsing HTML content. Format is YYYY-MM-DD. example: '2023-11-16T01:36:32.547Z' format: date-time type: string author: description: If available, the author of the content. example: Humza Naveed anyOf: - type: string - type: 'null' id: description: >- The temporary ID for the document. Useful for the /contents endpoint. example: https://arxiv.org/abs/2307.06435 type: string image: description: The URL of an image associated with the search result, if available. example: https://arxiv.org/pdf/2307.06435.pdf/page_1.png format: uri type: string favicon: description: The URL of the favicon for the search result's domain. example: https://arxiv.org/favicon.ico format: uri type: string text: description: The full content text of the search result. example: >- Abstract Large Language Models (LLMs) have recently demonstrated remarkable capabilities... type: string highlights: description: Array of highlights extracted from the search result content. example: - Such requirements have limited their adoption... type: array items: type: string highlightScores: description: Array of cosine similarity scores for each highlighted snippet. example: - 0.4600165784358978 type: array items: type: number format: float summary: description: Summary of the webpage. example: >- This overview paper on Large Language Models (LLMs) highlights key developments... type: string subpages: description: Array of subpages for the search result. type: array items: type: object properties: title: type: string description: The title of the search result. example: A Comprehensive Overview of Large Language Models url: type: string description: The URL of the search result. example: https://arxiv.org/pdf/2307.06435.pdf format: uri publishedDate: description: >- An estimate of the creation date, from parsing HTML content. Format is YYYY-MM-DD. example: '2023-11-16T01:36:32.547Z' format: date-time type: string author: description: If available, the author of the content. example: Humza Naveed anyOf: - type: string - type: 'null' id: description: >- The temporary ID for the document. Useful for the /contents endpoint. example: https://arxiv.org/abs/2307.06435 type: string image: description: >- The URL of an image associated with the search result, if available. example: https://arxiv.org/pdf/2307.06435.pdf/page_1.png format: uri type: string favicon: description: The URL of the favicon for the search result's domain. example: https://arxiv.org/favicon.ico format: uri type: string required: - title - url additionalProperties: false entities: description: >- Structured entity data for company, person, or publication search results. Returned for supported entity-backed categories. type: array items: oneOf: - $ref: '#/components/schemas/SearchCompanyEntityOutput' - $ref: '#/components/schemas/SearchPersonEntityOutput' - $ref: '#/components/schemas/SearchPublicationEntityOutput' type: object discriminator: propertyName: type mapping: company: $ref: '#/components/schemas/SearchCompanyEntityOutput' person: $ref: '#/components/schemas/SearchPersonEntityOutput' publication: $ref: '#/components/schemas/SearchPublicationEntityOutput' extras: description: >- Results from extras. Each field is returned only when requested via contents.extras. example: links: [] type: object properties: links: description: Array of links from the search result. example: [] type: array items: type: string imageLinks: description: Array of image URLs from the search result. example: [] type: array items: type: string richImageLinks: description: >- Array of images with their alt text, in the order the images appear on the page. example: - url: https://exa.ai/images/illustrations/api_illustration4.webp alt: High rate limits, low latency and high reliability. type: array items: type: object properties: url: type: string description: The URL of the image. alt: description: The alt text of the image, when the page provides one. type: string required: - url additionalProperties: false richLinks: description: >- Array of links with their anchor text, in the order they appear on the page. example: - url: https://dashboard.exa.ai anchor: API Dashboard type: array items: type: object properties: url: type: string description: The URL of the link. anchor: description: The anchor text of the link, when the page provides one. type: string required: - url additionalProperties: false codeBlocks: description: Array of code blocks from the search result. example: - text: pip install exa-py source: bash type: array items: type: object properties: text: type: string description: The contents of the code block. source: type: string description: The language the code block is annotated with, if any. required: - text - source additionalProperties: false additionalProperties: false required: - title - url additionalProperties: false CostDollarsOutput: type: object properties: total: description: >- Estimated total dollar cost for the completed request. This response value is not an invoice record. example: 0.007 format: float type: number search: description: >- Endpoint-dependent estimated search cost breakdown by retrieval mode. Instant, fast, and auto search responses may include neural search cost. Deep search modes may be reflected only in total. type: object properties: neural: description: Cost of neural search operations. example: 0.007 format: float type: number keyword: description: Cost of keyword search operations. example: 0.0025 format: float type: number additionalProperties: false summary: description: Cost of synthesized summary generation for search requests. example: 0.005 format: float type: number contents: description: >- Estimated cost breakdown for standalone content retrieval (text, highlights, and summaries billed outside the bundled search price). type: object properties: text: description: Cost of text extraction. example: 0.001 format: float type: number highlights: description: Cost of highlight extraction. example: 0.001 format: float type: number summary: description: Cost of per-result summary generation. example: 0.001 format: float type: number additionalProperties: false additionalProperties: false description: >- Endpoint-dependent estimated dollar cost breakdown for the completed request. Billing is computed from usage counters rather than this response object. SearchSynthesisOutputOutput: type: object properties: content: description: >- Synthesized content. String by default, or object when outputSchema is provided. oneOf: - type: string - type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' grounding: type: array items: type: object properties: field: type: string description: >- Field path in output.content, for example content or companies[0].funding. citations: type: array items: type: object properties: url: type: string format: uri description: Source URL. title: type: string description: Source title. required: - url - title additionalProperties: false description: Sources supporting this output field. confidence: type: string enum: - low - medium - high description: Model-reported reliability for this field. required: - field - citations - confidence additionalProperties: false description: Field-level grounding for synthesized output. required: - content - grounding additionalProperties: false description: Synthesized output. Returned when outputSchema is provided. SearchCompanyEntityOutput: type: object properties: id: type: string description: Stable company entity identifier. type: type: string const: company description: Entity discriminator. version: type: integer minimum: 1 description: Entity schema version. properties: type: object properties: name: anyOf: - type: string - type: 'null' description: Company name. foundedYear: anyOf: - type: integer - type: 'null' description: Year the company was founded. description: anyOf: - type: string - type: 'null' description: Short company description. workforce: anyOf: - type: object properties: total: anyOf: - type: number - type: 'null' description: Total estimated employee count. required: - total additionalProperties: false - type: 'null' description: Company workforce information. headquarters: anyOf: - type: object properties: address: anyOf: - type: string - type: 'null' description: Company headquarters street address. city: anyOf: - type: string - type: 'null' description: Company headquarters city. postalCode: anyOf: - type: string - type: 'null' description: Company headquarters postal code. country: anyOf: - type: string - type: 'null' description: Company headquarters country. required: - address - city - postalCode - country additionalProperties: false - type: 'null' description: Company headquarters information. financials: anyOf: - type: object properties: revenueAnnual: anyOf: - type: number - type: 'null' description: Estimated annual revenue in USD. fundingTotal: anyOf: - type: number - type: 'null' description: Total funding raised in USD. fundingLatestRound: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' description: Funding round name. date: anyOf: - type: string - type: 'null' description: Funding round date. amount: anyOf: - type: number - type: 'null' description: Funding round amount in USD. required: - name - date - amount additionalProperties: false - type: 'null' description: Most recent funding round, when available. required: - revenueAnnual - fundingTotal - fundingLatestRound additionalProperties: false - type: 'null' description: Company financial information. webTraffic: anyOf: - type: object properties: visitsMonthly: anyOf: - type: number - type: 'null' description: Estimated monthly website visits. countryRank: anyOf: - type: integer - type: 'null' description: >- Estimated website traffic rank within the company's primary country. avgDurationSeconds: anyOf: - type: number - type: 'null' description: Estimated average visit duration, in seconds. history: type: array items: type: object properties: value: type: number description: Estimated monthly visits for this period. dateFrom: type: string description: Start month for this value, formatted as YYYY-MM. dateTo: type: string description: End month for this value, formatted as YYYY-MM. required: - value - dateFrom - dateTo additionalProperties: false description: Historical monthly website visits. required: - visitsMonthly - countryRank - avgDurationSeconds - history additionalProperties: false - type: 'null' description: Company web traffic information. research: anyOf: - type: object properties: worksCount: anyOf: - type: integer - type: 'null' description: Number of works with an affiliated author. citationCount: anyOf: - type: integer - type: 'null' description: Lifetime citation count. areas: type: array items: type: string description: Ranked research areas, most active first. notableWorks: type: array items: type: object properties: title: anyOf: - type: string - type: 'null' description: Publication title. year: anyOf: - type: integer - type: 'null' description: Publication year. venue: anyOf: - type: string - type: 'null' description: Publication venue. citationCount: anyOf: - type: integer - type: 'null' description: Number of works citing this publication. doi: anyOf: - type: string - type: 'null' description: Digital Object Identifier. id: anyOf: - type: string - type: 'null' description: >- Resolved publication entity identifier, when available. type: anyOf: - type: string enum: - article - book - book-chapter - dataset - dissertation - preprint - report - review - type: 'null' description: Publication type. required: - title - year - venue - citationCount - doi - id - type additionalProperties: false description: Most-cited notable works. topResearchers: type: array items: type: object properties: person: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' description: Referenced person name. id: anyOf: - type: string - type: 'null' description: Referenced person entity identifier. required: - name - id additionalProperties: false - type: 'null' description: Referenced researcher. worksCount: anyOf: - type: integer - type: 'null' description: Number of works produced at the organization. citationCount: anyOf: - type: integer - type: 'null' description: >- Number of citations for works produced at the organization. required: - person - worksCount - citationCount additionalProperties: false description: >- Researchers ordered by works produced at the organization. required: - worksCount - citationCount - areas - notableWorks - topResearchers additionalProperties: false - type: 'null' description: Company research information. required: - name - foundedYear - description - workforce - headquarters - financials - webTraffic - research additionalProperties: false description: Company-specific entity fields. required: - id - type - version - properties additionalProperties: false SearchPersonEntityOutput: type: object properties: id: type: string description: Stable person entity identifier. type: type: string const: person description: Entity discriminator. version: type: integer minimum: 1 description: Entity schema version. properties: type: object properties: name: anyOf: - type: string - type: 'null' description: Person name. firstName: anyOf: - type: string - type: 'null' description: Person first name. lastName: anyOf: - type: string - type: 'null' description: Person last name. location: anyOf: - type: string - type: 'null' description: Person location. workHistory: type: array items: type: object properties: title: anyOf: - type: string - type: 'null' description: Role title. location: anyOf: - type: string - type: 'null' description: Role location. dates: anyOf: - type: object properties: from: anyOf: - type: string - type: 'null' description: Start date for the date range. to: anyOf: - type: string - type: 'null' description: End date for the date range. required: - from - to additionalProperties: false - type: 'null' description: Role date range. company: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: Referenced company identifier. name: anyOf: - type: string - type: 'null' description: Referenced company name. required: - id - name additionalProperties: false - type: 'null' description: Company for this role. required: - title - location - dates - company additionalProperties: false description: Known professional roles for this person. educationHistory: type: array items: type: object properties: degree: anyOf: - type: string - type: 'null' description: Degree or credential. dates: anyOf: - type: object properties: from: anyOf: - type: string - type: 'null' description: Start date for the date range. to: anyOf: - type: string - type: 'null' description: End date for the date range. required: - from - to additionalProperties: false - type: 'null' description: Education date range. institution: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: Referenced institution identifier. name: anyOf: - type: string - type: 'null' description: Referenced institution name. required: - id - name additionalProperties: false - type: 'null' description: Education institution. required: - degree - dates - institution additionalProperties: false description: Known education history for this person. research: anyOf: - type: object properties: worksCount: anyOf: - type: integer - type: 'null' description: Lifetime number of works. citationCount: anyOf: - type: integer - type: 'null' description: Lifetime citation count. hIndex: anyOf: - type: integer - type: 'null' description: Research h-index. firstPublicationYear: anyOf: - type: integer - type: 'null' description: Year of the first publication. latestPublicationYear: anyOf: - type: integer - type: 'null' description: Year of the latest publication. areas: type: array items: type: string description: Ranked research areas, most active first. notableWorks: type: array items: type: object properties: title: anyOf: - type: string - type: 'null' description: Publication title. year: anyOf: - type: integer - type: 'null' description: Publication year. venue: anyOf: - type: string - type: 'null' description: Publication venue. citationCount: anyOf: - type: integer - type: 'null' description: Number of works citing this publication. doi: anyOf: - type: string - type: 'null' description: Digital Object Identifier. id: anyOf: - type: string - type: 'null' description: >- Resolved publication entity identifier, when available. type: anyOf: - type: string enum: - article - book - book-chapter - dataset - dissertation - preprint - report - review - type: 'null' description: Publication type. required: - title - year - venue - citationCount - doi - id - type additionalProperties: false description: Most-cited notable works. required: - worksCount - citationCount - hIndex - firstPublicationYear - latestPublicationYear - areas - notableWorks additionalProperties: false - type: 'null' description: Person research information. required: - name - firstName - lastName - location - workHistory - educationHistory - research additionalProperties: false description: Person-specific entity fields. required: - id - type - version - properties additionalProperties: false SearchPublicationEntityOutput: type: object properties: id: type: string description: Stable publication entity identifier. type: type: string const: publication description: Entity discriminator. version: type: integer minimum: 1 description: Entity schema version. properties: type: object properties: title: anyOf: - type: string - type: 'null' description: Publication title. year: anyOf: - type: integer - type: 'null' description: Publication year. date: anyOf: - type: string - type: 'null' description: Publication date. type: anyOf: - type: string enum: - article - book - book-chapter - dataset - dissertation - preprint - report - review - type: 'null' description: Publication type. language: anyOf: - type: string - type: 'null' description: Publication language. citationCount: anyOf: - type: integer - type: 'null' description: Number of works citing this publication (incoming references). authors: type: array items: type: object properties: name: anyOf: - type: string - type: 'null' description: Author display name. id: anyOf: - type: string - type: 'null' description: Resolved person entity identifier, when available. required: - name - id additionalProperties: false description: Ordered list of authors. referenceCount: anyOf: - type: integer - type: 'null' description: Number of works this publication cites (outgoing references). abstract: anyOf: - type: string - type: 'null' description: Publication abstract text. doi: anyOf: - type: string - type: 'null' description: Bare DOI identifier (e.g. 10.1234/abcd). required: - title - year - date - type - language - citationCount - authors - referenceCount - abstract - doi additionalProperties: false description: Publication-specific entity fields. required: - id - type - version - properties additionalProperties: false headers: XRequestId: description: >- Unique identifier for the request. Matches the `requestId` field returned in response bodies that carry one. schema: type: string example: 07e29bb1f4f1dd05f0d4b57bbcf6e4b8 XExaQueued: description: >- Whether the request waited in the customer rate-limit queue before being admitted. schema: type: string enum: - 'true' - 'false' example: 'false' XExaQueueMs: description: Total milliseconds the request waited in the customer rate-limit queue. schema: type: string example: '0' responses: BadRequestResponse: description: The request body or query parameters failed validation. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: example: requestId: 0a1b2c3d4e5f60718293a4b5c6d7e8f9 error: >- Invalid request body: query: Invalid input: expected string, received undefined tag: INVALID_REQUEST_BODY schema: $ref: '#/components/schemas/ErrorResponse' UnauthorizedResponse: description: The API key is missing or invalid. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: example: requestId: f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2 error: Invalid API key tag: INVALID_API_KEY schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequestsResponse: description: A rate limit for this API key, team, or network was exceeded. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: example: requestId: 7f9b1d3e5a0c2e4b6d8f0a2c4e6b8d0f error: >- You've exceeded the Exa rate limit for your network. If you believe this is in error, please email hello@exa.ai :) tag: RATE_LIMIT_EXCEEDED schema: $ref: '#/components/schemas/ErrorResponse' InternalServerErrorResponse: description: An unexpected error occurred while processing the request. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: example: requestId: 9b1d3f5e7a0c2e4b6d8f0a2c4e6b8d0f error: >- Sorry, we encountered an error while processing your request. Please try again later tag: DEFAULT_ERROR schema: $ref: '#/components/schemas/ErrorResponse' ServiceUnavailableResponse: description: >- Exa is temporarily over capacity or unavailable. The request was not processed; retry with exponential backoff. headers: x-request-id: $ref: '#/components/headers/XRequestId' content: application/json: example: requestId: b3d5f7a9c1e0a2c4e6b8d0f2a4c6e8b1 error: >- Exa is temporarily over capacity. Please retry with exponential backoff. tag: SERVICE_OVERLOADED schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: apiKey: type: apiKey name: x-api-key in: header description: >- Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer . bearer: type: http scheme: bearer description: >- Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer . ````