获取页面内容

通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。

POST /v1/page/{domain}

获取页面内容

cURL

curl --request POST \
  --url https://api.mintlify.com/discovery/v1/page/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>"
}
'

import requests

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

payload = { "path": "<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({path: '<string>'})
};

fetch('https://api.mintlify.com/discovery/v1/page/{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/page/{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([
    'path' => '<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/page/{domain}"

	payload := strings.NewReader("{\n  \"path\": \"<string>\"\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/page/{domain}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/discovery/v1/page/{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  \"path\": \"<string>\"\n}"

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

200

{
  "path": "<string>",
  "content": "<string>"
}

{
  "message": "<string>"
}

​

速率限制

• 每个 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

path · string · 必填

要检索内容的页面路径或 slug。对应于 Search documentation 端点返回的 page 字段。

响应

200

application/json

页面内容检索成功

path · string

所请求的页面路径。

content · string

页面的完整文本内容。