跳转到主要内容
POST
/
search
/
{domain}
搜索文档
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>"
  }
}
'
import requests

url = "https://api.mintlify.com/discovery/v1/search/{domain}"

payload = {
"query": "<string>",
"pageSize": 10,
"filter": {
"version": "<string>",
"language": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
pageSize: 10,
filter: {version: '<string>', language: '<string>'}
})
};

fetch('https://api.mintlify.com/discovery/v1/search/{domain}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintlify.com/discovery/v1/search/{domain}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'pageSize' => 10,
'filter' => [
'version' => '<string>',
'language' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.mintlify.com/discovery/v1/search/{domain}"

payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.mintlify.com/discovery/v1/search/{domain}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/discovery/v1/search/{domain}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

授权

Authorization
string
header
必填

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

路径参数

domain
string
必填

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

请求体

application/json
query
string
必填

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

pageSize
number
默认值:10

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

filter
object

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

响应

200 - application/json

搜索结果

content
string

来自你文档的匹配内容。

path
string

源文档所在的路径或 URL。

metadata
object

有关搜索结果的额外 metadata。