v1

OpenAPI 3.1.02026-08-0458114534.0 KB

Find similar links

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

post/findSimilar

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.

startCrawlDatestring date-time nullable

Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format.

endCrawlDatestring date-time nullable

Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format.

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.

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.

excludeSourceDomainboolean nullable

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

Example request

{
  "includeDomains": [
    "arxiv.org",
    "exa.ai/blog"
  ],
  "excludeDomains": [
    "docs.python.org/3"
  ],
  "startCrawlDate": "2023-01-01T00:00:00.000Z",
  "endCrawlDate": "2023-12-31T00:00:00.000Z",
  "startPublishedDate": "2023-01-01T00:00:00.000Z",
  "endPublishedDate": "2023-12-31T00:00:00.000Z",
  "numResults": 10,
  "contents": {
    "text": {
      "maxCharacters": 1000,
      "verbosity": "standard",
      "includeSections": [
        "body",
        "header"
      ],
      "excludeSections": [
        "navigation",
        "footer",
        "sidebar"
      ]
    },
    "highlights": {
      "query": "Key advancements",
      "maxCharacters": 2000,
      "numSentences": 1,
      "highlightsPerUrl": 1
    },
    "summary": {
      "query": "Main developments",
      "schema": {
        "$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"
        ]
      }
    },
    "extras": {
      "links": 1,
      "imageLinks": 1
    },
    "context": true,
    "livecrawl": "preferred",
    "livecrawlTimeout": 1000,
    "maxAgeHours": 24,
    "subpages": 1
  },
  "url": "https://arxiv.org/abs/2307.06435",
  "category": "publication",
  "excludeSourceDomain": true
}

Response

requestIdstring

Unique identifier for the request.

contextstring

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

Example response

{
  "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",
      "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..."
      ],
      "highlightScores": [
        0.4600165784358978
      ],
      "summary": "This overview paper on Large Language Models (LLMs) highlights key developments...",
      "subpages": [
        {
          "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",
          "id": "https://arxiv.org/abs/2307.06435",
          "image": "https://arxiv.org/pdf/2307.06435.pdf/page_1.png",
          "favicon": "https://arxiv.org/favicon.ico"
        }
      ],
      "extras": {
        "links": []
      }
    }
  ],
  "costDollars": {
    "total": 0.007,
    "search": {
      "neural": 0.007
    }
  }
}