Skip to main content
POST
/
v2
/
assistant
/
{domain}
/
message
AI 助手消息 v2
curl --request POST \
  --url https://api.mintlify.com/discovery/v2/assistant/{domain}/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fp": "<string>",
  "messages": [
    {
      "id": "foobar",
      "role": "user",
      "parts": [
        {
          "type": "text",
          "text": "How do I get started"
        }
      ]
    }
  ],
  "threadId": null,
  "retrievalPageSize": 5,
  "filter": null,
  "context": [
    {
      "type": "code",
      "value": "<string>",
      "path": "<string>",
      "elementId": "<string>"
    }
  ]
}
'
{}
assistant 消息 v2 端点兼容 AI SDK v5+。如果你正在使用 AI SDK v4，请改用 assistant 消息 v1 端点。

​
与 useChat 集成

Vercel 的 AI SDK 提供的 useChat hook 是在你的应用程序中集成 assistant API 的推荐方式。
1

安装 AI SDK

npm i ai@^6 @ai-sdk/react
2

使用 hook

import { useState } from "react";
import { useChat } from "@ai-sdk/react";
import { DefaultChatTransport } from "ai";

function MyComponent({ domain }) {
  const [input, setInput] = useState("");

  const { messages, sendMessage } = useChat({
    transport: new DefaultChatTransport({
      api: `https://api.mintlify.com/discovery/v2/assistant/${domain}/message`,
      headers: {
        Authorization: `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`,
      },
      body: {
        fp: "anonymous",
        retrievalPageSize: 5,
        context: [
          {
            type: "code",
            value: 'const example = "code snippet";',
            elementId: "code-block-1",
          },
        ],
      },
    }),
  });

  return (
    <div>
      {messages.map((message) => (
        <div key={message.id}>
          {message.role === "user" ? "User: " : "Assistant: "}
          {message.parts
            .filter((part) => part.type === "text")
            .map((part) => part.text)
            .join("")}
        </div>
      ))}
      <form
        onSubmit={(e) => {
          e.preventDefault();
          if (input.trim()) {
            sendMessage({ text: input });
            setInput("");
          }
        }}
      >
        <input value={input} onChange={(e) => setInput(e.target.value)} />
        <button type="submit">Send</button>
      </form>
    </div>
  );
}
必填配置：
  • transport - 使用 DefaultChatTransport 来配置 API 连接。
  • body.fp - 指纹标识符（使用 'anonymous' 或唯一的用户标识符）。
  • body.retrievalPageSize - 要使用的搜索结果数量（推荐：5）。
可选配置：
  • body.context - 提供给 AI 助手的上下文信息数组。每个 context 对象包含：
    • type - 'code' 或 'textSelection' 之一。
    • value - 代码片段或选中的文本内容。
    • path（可选）- 源文件或页面的路径。
    • elementId（可选）- 包含该 context 的 UI 元素标识符。
更多详情参见 AI SDK 文档中的 useChat 和 Transport。

​
速率限制

AI 助手 API 有以下限制：
  • 每个 key 每月最多调用 10,000 次
  • 每个 Mintlify 组织每小时最多 10,000 个请求
  • 每个 IP 地址每天最多 10,000 个请求

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
domain
string
required

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

Body

application/json
​
fp
string
required

用于跟踪会话的指纹标识符。对匿名用户使用 anonymous，或提供一个唯一的用户标识符。

​
messages
object[]
required

会话中的消息数组。使用 @ai-sdk/react 包中的 useChat 钩子提供的 handleSubmit 函数来管理消息和流式响应。

​
threadId
string

一个可选的标识符，用于在多条消息之间保持会话的连续性。提供该值后，系统会将后续消息关联到同一个会话线程。当 event.type === 'finish' 时，响应中会在 event.threadId 字段返回该 threadId。

​
retrievalPageSize
number
default:5

用于生成回答时检索的文档搜索结果数量。数值越高，可用的上下文越多，但可能增加响应时间。推荐值：5。

​
filter
object

用于搜索的可选筛选条件。

​
context
object[]

提供给 AI 助手的可选上下文信息数组。

Response

200 - application/json

消息已成功生成

与 AI SDK v5 兼容的流式响应。使用 @ai-sdk/react 中的 useChat 钩子 来处理响应流。