搜索文档

以编程方式搜索你的文档，并检索与查询匹配的相关页面。

POST /v1/search/{domain}

搜索文档

cURL

curl --request POST \
  --url https://api.mintlify.com/discovery/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "scoreThreshold": 0.5,
  "filter": {
    "version": "<string>",
    "language": "<string>",
    "tag": "<string>"
  }
}
'

200

[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

​

速率限制

• 每个 Mintlify 组织每小时 10,000 次请求

授权

Authorization · string · header · 必填

Authorization 请求头需要携带 Bearer 令牌。请使用以 mint_dsc_ 为前缀的 AI 助手 API 密钥。它是一个可以安全用于客户端代码的公用密钥。你可以在控制台的 API 密钥页面 中生成它。

路径参数

domain · string · 必填

来自你的 domain.mintlify.app URL 的域名标识符。可以在控制台 URL 的末尾找到。例如，dashboard.mintlify.com/organization/domain 的域名标识符就是 domain。

请求体

application/json

query · string · 必填

在文档内容中要执行的搜索查询。

pageSize · integer · 默认值: 10

要返回的搜索结果数量。必须在 1 到 50 之间。若未指定，默认为 10。

必填范围: 1 <= x <= 50

scoreThreshold · number

结果的最低相关性分数。仅返回分数等于或高于此阈值的结果。必须介于 0 和 1 之间。

必填范围: 0 <= x <= 1

filter · object

用于缩小搜索结果范围的可选过滤参数。

Show child attributes

响应

200 - application/json

搜索结果

content · string

来自文档中匹配的内容。

path · string

源文档所在的路径或 URL。

metadata · object

与搜索结果相关的附加 metadata。