Assistant message

Generates a response message from the assistant for the specified domain.

​

与 useChat 集成

Vercel 的 AI SDK 提供的 useChat 钩子是将 AI 助手 API 集成到你的应用中的推荐方式。

Mintlify AI 助手 API 与 AI SDK v4 兼容。如果你使用 AI SDK v5 或更高版本，必须配置自定义 transport。

1. 安装 AI SDK v4

   npm i ai@^4.1.15
   

2. 使用该钩子

   import { useChat } from 'ai/react';
   
   function MyComponent({ domain }) {
     const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({
       api: `https://api-dsc.mintlify.com/v1/assistant/${domain}/message`,
       headers: {
         'Authorization': `Bearer ${process.env.MINTLIFY_TOKEN}`,
       },
       body: {
         fp: 'anonymous',
         retrievalPageSize: 5,
       },
       streamProtocol: 'data',
       sendExtraMessageFields: true,
     });
   
     return (
       <div>
         {messages.map((message) => (
           <div key={message.id}>
             {message.role === 'user' ? 'User: ' : 'Assistant: '}
             {message.content}
           </div>
         ))}
         <form onSubmit={handleSubmit}>
           <input value={input} onChange={handleInputChange} />
           <button type="submit">Send</button>
         </form>
       </div>
     );
   }
   

   Mintlify 的必填配置：

   • streamProtocol: 'data' - 启用流式响应所必需。
   • sendExtraMessageFields: true - 发送消息 metadata 所必需。
   • body.fp - 指纹标识符（使用 'anonymous' 或某个用户标识符）。
   • body.retrievalPageSize - 要使用的搜索结果数量（推荐：5）。

在 AI SDK 文档中查看 useChat 以了解更多详情。

​

速率限制

AI 助手 API 的限制如下：

• 每个 key 每月最多使用 10,000 次
• 每个 Mintlify 组织每小时最多 10,000 次请求
• 每个 IP 每日最多 10,000 次请求

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. See the Assistant API Key documentation for details on how to get your API key.

Path Parameters

domain · string · required

The domain identifier from your domain.mintlify.app URL. Can be found at the end of your dashboard URL. For example, dashboard.mintlify.com/organization/domain has a domain identifier of domain.

Body

application/json

fp · string · required

Fingerprint identifier for tracking conversation sessions. Use 'anonymous' for anonymous users or provide a unique user identifier.

messages · object[] · required

Array of messages in the conversation. On the frontend, you will likely want to use the handleSubmit function from the @ai-sdk package's useChat hook to append user messages and handle streaming responses, rather than manually defining the objects in this array as they have so many parameters.

显示 子属性

threadId · string

An optional identifier used to maintain conversation continuity across multiple messages. When provided, it allows the system to associate follow-up messages with the same conversation thread. The threadId is returned in the response as event.threadId when event.type === 'finish'.

retrievalPageSize · number · default: 5

Number of documentation search results to use for generating the response. Higher values provide more context but may increase response time. Recommended: 5.

filter · object

Optional filter criteria for the search

显示 子属性

Response

200 - application/json

Message generated successfully

Response object that streams formatted data stream parts with the specified status, headers, and content. This matches what is expected from the AI SDK as documented at ai-sdk.dev/docs/ai-sdk-ui/streaming-data. Instead of writing your own parser, it is recommended to use the useChat hook from ai-sdk as documented here.