跳转到主要内容
POST
/
search
/
{domain}
搜索文档
curl --request POST \
  --url https://api-dsc.mintlify.com/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'
[
  {
    "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

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

Response

200 - application/json

搜索结果

​
content
string

您文档中与之匹配的内容。

​
path
string

源文档所在的路径或 URL。

​
metadata
object

关于搜索结果的额外 metadata。