跳转到主要内容
POST
AI 助手的消息
assistant 消息 v2 端点兼容 AI SDK v5+。如果你正在使用 AI SDK v4,请改用 assistant 消息 v1 端点

useChat 集成

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

安装 AI SDK

2

使用 hook

必填配置:
  • transport - 使用 DefaultChatTransport 来配置 API 连接。
  • body.fp - 指纹标识符 (使用 'anonymous' 或唯一的用户标识符) 。
  • body.retrievalPageSize - 要使用的搜索结果数量 (推荐:5) 。
可选配置:
  • body.context - 提供给 AI 助手的上下文信息数组。每个 context 对象包含:
    • type - 'code''textSelection' 之一。
    • value - 代码片段或选中的文本内容。
    • path (可选) - 源文件或页面的路径。
    • elementId (可选) - 包含该 context 的 UI 元素标识符。
  • body.currentPath - 用户当前正在查看页面的路径。提供该字段时,AI 助手会利用此 context 提供更相关的回答。最大长度:200 个字符。
更多详情参见 AI SDK 文档中的 useChatTransport

速率限制

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

授权

Authorization
string
header
必填

Authorization 请求头需要携带 Bearer 令牌。请使用 assistant API 密钥。你可以在控制台的 API 密钥页面 中生成一个。在生产环境中,请通过你的后端代理请求,而不是将密钥嵌入到客户端代码中。

路径参数

domain
string
必填

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

请求体

application/json
fp
string
必填

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

messages
object[]
必填

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

threadId
string

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

retrievalPageSize
number
默认值:5

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

filter
object

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

context
object[]

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

currentPath
string

用户当前正在查看的页面路径。若提供,AI 助手会利用该上下文给出更相关的回答。最大长度:200 个字符。

响应

200 - application/json

消息已成功生成

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