Find similar links

Changed on

Find links similar to the provided URL and optionally retrieve their contents. Deprecated: prefer /search with a query describing the source.

post/findSimilar

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/findSimilar
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

includeDomainsstring[] nullable

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.

excludeDomainsstring[] nullable

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.

startPublishedDatestring date-time nullable

Only links with a published date after this will be returned. Must be specified in ISO 8601 format.

endPublishedDatestring date-time nullable

Only links with a published date before this will be returned. Must be specified in ISO 8601 format.

numResultsinteger nullable

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.

urlstring required

The url for which you would like to find similar links.

category'company' | 'publication' | 'news' | 'personal site' | 'financial report' | 'people' nullable

A data category to focus on. Other strings are accepted and used as category hints. people and company return higher-quality people profiles and company pages. publication returns scholarly publications such as research papers, preprints, and journal articles, with metadata like authors, venue, and citations. With company or people, domain, URL, published-date, and text filters are ignored.

excludeSourceDomainboolean nullable

If true, results from the same domain as the source url are excluded.

startCrawlDatestring date-time nullable

Deprecated. Ignored by the API.

endCrawlDatestring date-time nullable

Deprecated. Ignored by the API.

includeTextstring[] nullable

Deprecated. List of strings that must be present in the webpage text of results. Matching is approximate (word-level rather than exact phrase), so a multi-word entry can match pages where its words appear separately. Up to 50 strings, each up to 4096 characters. Ignored for the company and people categories.

excludeTextstring[] nullable

Deprecated. List of strings that must not be present in the webpage text of results. Matching is approximate (word-level rather than exact phrase). Up to 50 strings, each up to 4096 characters. Ignored for the company and people categories.

Response

OK

requestIdstring

Unique identifier for the request.

searchTimenumber

Server-side processing time in milliseconds. May exclude output synthesis time, so it can be lower than end-to-end latency.

contextstring

Deprecated. Use results[].highlights or results[].text instead. Combined context string from search results.

Changes

    • info

      request property //////// deprecated

    • info

      request property //////// deprecated

    • info

      request property ////// deprecated

    • info

      request property ////// deprecated

    • info

      request property //////// deprecated

    • info

      request property //////// deprecated

    • info

      request property ////// deprecated

    • info

      request property ////// deprecated