Find similar links

{
  "$defs": {
    "ContentsOptions": {
      "properties": {
        "context": {
          "anyOf": [
            {
              "description": "Deprecated: Use highlights or text instead. Returns page contents as a combined context string.",
              "oneOf": [
                {
                  "description": "Deprecated: Use highlights or text instead. Returns page contents as a combined context string.",
                  "type": "boolean"
                },
                {
                  "description": "Deprecated: Use highlights or text instead. Returns page contents as a combined context string.",
                  "properties": {
                    "maxCharacters": {
                      "description": "Deprecated. Maximum character limit for the context string. Maximum supported value is 10000.",
                      "maximum": 10000,
                      "minimum": 1,
                      "type": "integer"
                    }
                  },
                  "type": "object"
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "extras": {
          "anyOf": [
            {
              "description": "Extra parameters to pass.",
              "properties": {
                "codeBlocks": {
                  "anyOf": [
                    {
                      "default": 0,
                      "description": "Number of code blocks to return for each result.",
                      "maximum": 1000,
                      "minimum": 0,
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "imageLinks": {
                  "anyOf": [
                    {
                      "default": 0,
                      "description": "Number of images to return for each result.",
                      "maximum": 1000,
                      "minimum": 0,
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "links": {
                  "anyOf": [
                    {
                      "default": 0,
                      "description": "Number of URLs to return from each webpage.",
                      "maximum": 1000,
                      "minimum": 0,
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "richImageLinks": {
                  "anyOf": [
                    {
                      "default": 0,
                      "description": "Number of rich image links to return for each result.",
                      "maximum": 1000,
                      "minimum": 0,
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "richLinks": {
                  "anyOf": [
                    {
                      "default": 0,
                      "description": "Number of rich links to return for each result.",
                      "maximum": 1000,
                      "minimum": 0,
                      "type": "integer"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "highlights": {
          "anyOf": [
            {
              "description": "Text snippets the LLM identifies as most relevant from each page.",
              "oneOf": [
                {
                  "default": false,
                  "description": "If true, returns highlights with default settings. If false, disables highlights.",
                  "title": "Simple highlights retrieval",
                  "type": "boolean"
                },
                {
                  "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.",
                  "properties": {
                    "dynamic": {
                      "anyOf": [
                        {
                          "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 `Asale-Beta: dynamic-highlights-2026-08-28` request header; requests setting `dynamic` without it are rejected.",
                          "type": "boolean"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "highlightsPerUrl": {
                      "anyOf": [
                        {
                          "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.",
                          "minimum": 1,
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "maxCharacters": {
                      "anyOf": [
                        {
                          "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.",
                          "maximum": 10000,
                          "minimum": 1,
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "numSentences": {
                      "anyOf": [
                        {
                          "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.",
                          "minimum": 1,
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "query": {
                      "anyOf": [
                        {
                          "description": "Custom query that guides which highlights the LLM picks.",
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "verbosity": {
                      "anyOf": [
                        {
                          "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. Asalect budgets are tuned by Asale and may change. Not compatible with maxCharacters or numSentences. Beta: requires the `Asale-Beta: dynamic-highlights-2026-08-28` request header; requests setting `verbosity` without it are rejected.",
                          "enum": [
                            "low",
                            "medium",
                            "high"
                          ],
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "title": "Advanced highlights options",
                  "type": "object"
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "livecrawl": {
          "anyOf": [
            {
              "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.",
              "enum": [
                "never",
                "always",
                "fallback",
                "preferred"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "livecrawlTimeout": {
          "anyOf": [
            {
              "default": 10000,
              "description": "The timeout for livecrawling in milliseconds.",
              "exclusiveMinimum": 0,
              "maximum": 90000,
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "maxAgeHours": {
          "anyOf": [
            {
              "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.",
              "maximum": 720,
              "minimum": -1,
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "subpageTarget": {
          "anyOf": [
            {
              "description": "Term to find specific subpages of search results. Can be a single string or an array of strings.",
              "oneOf": [
                {
                  "maxLength": 100,
                  "minLength": 1,
                  "type": "string"
                },
                {
                  "items": {
                    "maxLength": 100,
                    "minLength": 1,
                    "type": "string"
                  },
                  "maxItems": 100,
                  "minItems": 0,
                  "type": "array"
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "subpages": {
          "anyOf": [
            {
              "default": 0,
              "description": "The number of subpages to crawl. The actual number crawled may be limited by system constraints.",
              "maximum": 100,
              "minimum": 0,
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "summary": {
          "anyOf": [
            {
              "description": "Summary of the webpage.",
              "properties": {
                "query": {
                  "anyOf": [
                    {
                      "description": "Custom query for the LLM-generated summary.",
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "schema": {
                  "anyOf": [
                    {
                      "additionalProperties": {
                        "$ref": "#/$defs/JsonValue"
                      },
                      "description": "JSON schema for structured output from summary. See for JSON Schema documentation.",
                      "propertyNames": {
                        "type": "string"
                      },
                      "type": "object"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "text": {
          "anyOf": [
            {
              "description": "Text extraction options for each result.",
              "oneOf": [
                {
                  "default": false,
                  "description": "If true, returns full page text with default settings. If false, disables text return.",
                  "title": "Simple text retrieval",
                  "type": "boolean"
                },
                {
                  "description": "Advanced options for controlling text extraction. Use this when you need to limit text length or include HTML structure.",
                  "properties": {
                    "excludeSections": {
                      "anyOf": [
                        {
                          "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.",
                          "items": {
                            "enum": [
                              "header",
                              "navigation",
                              "banner",
                              "body",
                              "sidebar",
                              "footer",
                              "metadata"
                            ],
                            "type": "string"
                          },
                          "type": "array"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "includeHtmlTags": {
                      "anyOf": [
                        {
                          "default": false,
                          "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.",
                          "type": "boolean"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "includeSections": {
                      "anyOf": [
                        {
                          "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.",
                          "items": {
                            "enum": [
                              "header",
                              "navigation",
                              "banner",
                              "body",
                              "sidebar",
                              "footer",
                              "metadata"
                            ],
                            "type": "string"
                          },
                          "type": "array"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "maxCharacters": {
                      "anyOf": [
                        {
                          "description": "Maximum character limit for the full page text. Useful for controlling response size and API costs. Maximum supported value is 10000.",
                          "maximum": 10000,
                          "minimum": 1,
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "verbosity": {
                      "anyOf": [
                        {
                          "default": "compact",
                          "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.",
                          "enum": [
                            "compact",
                            "standard",
                            "full"
                          ],
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "title": "Advanced text options",
                  "type": "object"
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "FindSimilarRequest": {
      "properties": {
        "category": {
          "anyOf": [
            {
              "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",
              "enum": [
                "company",
                "publication",
                "news",
                "personal site",
                "financial report",
                "people"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "contents": {
          "anyOf": [
            {
              "$ref": "#/$defs/ContentsOptions",
              "description": "Content options for text, highlights, summary, extras, and freshness controls."
            },
            {
              "type": "null"
            }
          ]
        },
        "endCrawlDate": {
          "anyOf": [
            {
              "description": "Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format.",
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "endPublishedDate": {
          "anyOf": [
            {
              "description": "Only links with a published date before this will be returned. Must be specified in ISO 8601 format.",
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "excludeDomains": {
          "anyOf": [
            {
              "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.",
              "items": {
                "type": "string"
              },
              "maxItems": 1200,
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "excludeSourceDomain": {
          "anyOf": [
            {
              "description": "If true, results from the same domain as the source url are excluded.",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "includeDomains": {
          "anyOf": [
            {
              "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.",
              "items": {
                "type": "string"
              },
              "maxItems": 1200,
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "numResults": {
          "anyOf": [
            {
              "default": 10,
              "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.",
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "startCrawlDate": {
          "anyOf": [
            {
              "description": "Deprecated and has no effect; ignored by the API. Must be specified in ISO 8601 format.",
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "startPublishedDate": {
          "anyOf": [
            {
              "description": "Only links with a published date after this will be returned. Must be specified in ISO 8601 format.",
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "url": {
          "description": "The url for which you would like to find similar links.",
          "minLength": 3,
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "type": "object"
    },
    "JsonValue": {
      "description": "Any JSON value.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "items": {
            "$ref": "#/$defs/JsonValue"
          },
          "type": "array"
        },
        {
          "additionalProperties": {
            "$ref": "#/$defs/JsonValue"
          },
          "propertyNames": {
            "type": "string"
          },
          "type": "object"
        }
      ]
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "$ref": "#/$defs/FindSimilarRequest"
    }
  },
  "required": [
    "body"
  ],
  "type": "object"
}