搜索文档

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

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>"
  }
}
'

import requests

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

payload = {
    "query": "<string>",
    "pageSize": 10,
    "scoreThreshold": 0.5,
    "filter": {
        "version": "<string>",
        "language": "<string>",
        "tag": "<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,
    scoreThreshold: 0.5,
    filter: {version: '<string>', language: '<string>', tag: '<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,
    'scoreThreshold' => 0.5,
    'filter' => [
        'version' => '<string>',
        'language' => '<string>',
        'tag' => '<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  \"scoreThreshold\": 0.5,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\",\n    \"tag\": \"<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  \"scoreThreshold\": 0.5,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\",\n    \"tag\": \"<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  \"scoreThreshold\": 0.5,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\",\n    \"tag\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

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

​

速率限制

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

授权

Authorization · string · header · 必填

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

路径参数

domain · string · 必填

来自你的 domain.mintlify.site 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。