触发预览部署

POST

project

preview

{projectId}

触发预览部署

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>",
  "auth": {
    "type": "password",
    "password": "<string>"
  }
}
'

import requests

url = "https://api.mintlify.com/v1/project/preview/{projectId}"

payload = {
    "branch": "<string>",
    "auth": {
        "type": "password",
        "password": "<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({branch: '<string>', auth: {type: 'password', password: '<string>'}})
};

fetch('https://api.mintlify.com/v1/project/preview/{projectId}', 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/v1/project/preview/{projectId}",
  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([
    'branch' => '<string>',
    'auth' => [
        'type' => 'password',
        'password' => '<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/v1/project/preview/{projectId}"

	payload := strings.NewReader("{\n  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<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/v1/project/preview/{projectId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/project/preview/{projectId}")

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  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<string>\"\n  }\n}"

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

{
  "statusId": "<string>",
  "previewUrl": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。响应中包含一个 statusId，你可以将其传递给 Get deployment status 以跟踪部署进度。

分支要求

branch 必须存在于与你的 Mintlify 项目连接的仓库中，并且你必须已安装 Mintlify GitHub 应用。此端点不支持 fork 上的分支。有关如何预览来自 fork 的更改，请参阅Fork 拉取请求。

用例

CI/CD 流水线：在用户打开或更新拉取请求时自动创建预览部署。
定时预览：按计划为长期运行的功能分支生成预览。
自定义工具：将预览创建集成到内部工作流或 Slack 机器人中。

预览的访问权限

默认情况下，通过此端点创建的预览可公开访问，除非你为预览启用了身份验证。请参阅限制预览部署的访问权限。要限制对特定预览的访问，请在请求体中传入 auth 对象。Mintlify 会在将部署加入队列之前，将访问设置应用于该预览。如果省略 auth，预览将保留其当前的访问设置。

{ "type": "password", "password": "..." }：任何拥有密码的人都可以查看该预览。密码长度必须至少为 8 个字符。设置密码会替换该预览上已有的任何密码。
{ "type": "mintlify" }：只有已登录 Mintlify 的组织成员才能查看该预览。

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "feature/new-guide",
    "auth": { "type": "password", "password": "review-pass-123" }
  }'

设置 auth 需满足以下要求：

你的方案必须包含预览部署身份验证。否则，该端点返回 403。
你的站点必须已启用身份验证或预览身份验证。否则，该端点返回 409。
必须在预览本身上启用身份验证。否则，该端点返回 409。

速率限制

此端点允许每个组织每分钟最多 5 个请求。

授权

Authorization

string

header

必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面中生成一个。

路径参数

projectId

string

必填

项目 ID。可在控制台的 API keys 页面中复制。

请求体

application/json

branch

string

必填

要为其创建预览部署的 Git 分支名称。

Minimum string length: 1

auth

密码 · object

要应用于预览的访问限制。省略此项可保持预览当前的访问设置不变。需要包含预览身份验证的方案，并且你的站点必须已启用身份验证或预览身份验证。

密码
控制台登录

Show child attributes

响应

预览部署已成功加入队列。

statusId

string

用于跟踪预览部署的状态 ID。可将其与 Get deployment status 端点配合使用。

previewUrl

string

预览部署所托管的 URL。

⌘I

触发预览部署

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>",
  "auth": {
    "type": "password",
    "password": "<string>"
  }
}
'

import requests

url = "https://api.mintlify.com/v1/project/preview/{projectId}"

payload = {
    "branch": "<string>",
    "auth": {
        "type": "password",
        "password": "<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({branch: '<string>', auth: {type: 'password', password: '<string>'}})
};

fetch('https://api.mintlify.com/v1/project/preview/{projectId}', 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/v1/project/preview/{projectId}",
  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([
    'branch' => '<string>',
    'auth' => [
        'type' => 'password',
        'password' => '<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/v1/project/preview/{projectId}"

	payload := strings.NewReader("{\n  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<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/v1/project/preview/{projectId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/project/preview/{projectId}")

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  \"branch\": \"<string>\",\n  \"auth\": {\n    \"type\": \"password\",\n    \"password\": \"<string>\"\n  }\n}"

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

{
  "statusId": "<string>",
  "previewUrl": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API 参考

管理

Agent

Assistant

搜索

数据分析

静态导出

触发预览部署

分支要求

用例

预览的访问权限

速率限制

授权

路径参数

请求体

响应

​分支要求

​用例

​预览的访问权限

​速率限制

授权

路径参数

请求体

响应

分支要求

用例

预览的访问权限

速率限制