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>"
}
]
}
'{}Genera un mensaje de respuesta del assistant para el domain indicado. Compatible con el SDK de IA v5 o superior.
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>"
}
]
}
'{}useChatuseChat del AI SDK de Vercel es la forma recomendada de integrar la assistant API en tu aplicación.
Usar el 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 - Usa DefaultChatTransport para configurar la conexión con la API.body.fp - Identificador de huella digital (usa 'anonymous' o un identificador único de usuario).body.retrievalPageSize - Número de resultados de búsqueda que se usarán (recomendado: 5).body.context - Array de información contextual que se le proporciona al assistant. Cada objeto de contexto contiene:
type - Puede ser 'code' o 'textSelection'.value - El fragmento de código o el contenido de texto seleccionado.path (opcional) - Ruta al archivo o a la página de origen.elementId (opcional) - Identificador del elemento de la interfaz de usuario que contiene el contexto.La cabecera Authorization espera un token de tipo Bearer. Usa una clave de API para assistant (con el prefijo mint_dsc_). Esta es una clave pública segura para utilizar en código del lado del cliente. Genérala desde la página de claves de API de tu dashboard.
El identificador de domain de tu URL, por ejemplo domain.mintlify.app. Puedes encontrarlo al final de la URL de tu dashboard. Por ejemplo, en dashboard.mintlify.com/organization/domain, el identificador de domain es domain.
Identificador de huella (fingerprint) para realizar el seguimiento de las sesiones de conversación. Usa anonymous para usuarios anónimos o proporciona un identificador de usuario único.
Array de mensajes de la conversación. Usa la función handleSubmit del hook useChat del paquete @ai-sdk/react para gestionar los mensajes y las respuestas en streaming.
Show child attributes
Un identificador opcional que se utiliza para mantener la continuidad de la conversación a través de varios mensajes. Cuando se incluye, permite que el sistema asocie los mensajes posteriores con el mismo hilo de conversación. El threadId se devuelve en la respuesta como event.threadId cuando event.type === 'finish'.
Número de resultados de búsqueda en la documentación que se utilizarán para generar la respuesta. Valores más altos proporcionan más contexto, pero pueden aumentar el tiempo de respuesta. Recomendado: 5.
Criterios de filtrado opcionales para la búsqueda.
Show child attributes
Array opcional de información contextual para proporcionar al assistant.
Show child attributes
Mensaje generado con éxito
Streaming de respuestas compatible con AI SDK v5. Usa el hook useChat de @ai-sdk/react para gestionar el flujo de la respuesta.
Was this page helpful?