搜索文档

在文档中执行语义搜索和关键词搜索，支持可配置的过滤和分页。

POST /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,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'

200

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

Authorizations

Authorization · string · header · required

Authorization 头需要携带 Bearer 令牌。有关如何获取 API key 的详细信息，请参阅 Assistant API Key 文档。

Path Parameters

domain · string · required

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

Body

application/json

query · string · required

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

pageSize · number · default: 10

要返回的搜索结果数量。如未指定，则默认为 10。

filter · object

可选筛选参数，可用于缩小搜索结果范围。

显示 子属性

filter. version · string

根据文档版本筛选结果。

filter. language · string

按内容语言筛选结果。

Response

200 - application/json

搜索结果

content · string

来自你文档的匹配内容。

path · string

源文档所在的路径或 URL。

metadata · object

有关搜索结果的额外 metadata。