Passer au contenu principal
POST
Créer un message de l’Assistant
L’endpoint assistant message v2 est compatible avec AI SDK v5+. Si vous utilisez l’AI SDK v4, utilisez plutôt l’endpoint assistant message v1.

Intégration avec useChat

Le hook useChat de l’AI SDK de Vercel est la méthode recommandée pour intégrer l’API Assistant dans votre application.
1

Installer l'AI SDK

2

Utiliser le hook

Configuration requise :
  • transport - Utilisez DefaultChatTransport pour configurer la connexion à l’API.
  • body.fp - Identifiant d’empreinte (utilisez 'anonymous' ou un identifiant utilisateur unique).
  • body.retrievalPageSize - Nombre de résultats de recherche à utiliser (recommandé : 5).
Configuration optionnelle :
  • body.context - Tableau d’informations contextuelles à fournir à l’Assistant. Chaque objet de contexte contient :
    • type - Soit 'code' soit 'textSelection'.
    • value - Le morceau de code ou le contenu textuel sélectionné.
    • path (optionnel) - Chemin vers le fichier source ou la page.
    • elementId (optionnel) - Identifiant de l’élément d’interface contenant le contexte.
  • body.currentPath - Chemin de la page que l’utilisateur est en train de consulter. Lorsqu’il est fourni, l’Assistant utilise ce contexte pour fournir des réponses plus pertinentes. Longueur maximale : 200 caractères.
Voir useChat et Transport dans la documentation de l’AI SDK pour plus de détails.

Migrer depuis la v1

Le point de terminaison v1 n’est plus pris en charge et renvoie 410 Gone. Pour migrer, remplacez l’URL /discovery/v1/assistant/{domain}/message par /discovery/v2/assistant/{domain}/message, puis mettez à jour vos messages et la gestion du flux. Votre clé API et ces champs du corps ne changent pas : fp, threadId, threadKey, regenerate, retrievalPageSize, filter, context et currentPath.

Si vous utilisez useChat

Passez à AI SDK v5 ou ultérieur et utilisez DefaultChatTransport comme indiqué dans Intégration avec useChat. Supprimez streamProtocol et sendExtraMessageFields. Ils ne sont pas nécessaires en v2. Affichez les messages à partir de message.parts au lieu de message.content.

Si vous appelez l’API directement

Les messages utilisent parts au lieu de content. Supprimez la chaîne content et envoyez le texte sous forme de partie texte. Le rôle data n’est plus accepté.
Les pièces jointes sont des parties file. Remplacez experimental_attachments par des entrées dans parts.
Les réponses sont diffusées sous forme de server-sent events. La v1 renvoie le data stream d’AI SDK v4, composé de lignes 0:"...". La v2 renvoie le UI message stream d’AI SDK. Chaque événement est une ligne JSON data: {...}, le texte arrive dans des événements text-delta et le flux se termine par data: [DONE]. Les en-têtes de réponse X-Thread-Id, X-Thread-Key et X-Message-Id restent inchangés.

Limites de débit

L’API Assistant est soumise à la limite suivante :
  • 10 000 requêtes par organisation Mintlify et par heure

Autorisations

Authorization
string
header
requis

L'en-tête Authorization attend un jeton Bearer. Utilisez une clé d'API assistant. Générez-en une depuis la page des clés d'API de votre Dashboard. En production, faites transiter les requêtes par votre backend plutôt que d'intégrer la clé dans du code côté client.

Paramètres de chemin

domain
string
requis

L’identifiant de domaine provenant de votre URL domain.mintlify.site. Il se trouve à la fin de l’URL de votre Dashboard. Par exemple, dashboard.mintlify.com/organization/domain a un identifiant de domaine égal à domain.

Corps

application/json
fp
string
requis

Identifiant d’empreinte pour le suivi des sessions de conversation. Utilisez anonymous pour les utilisateurs non authentifiés ou fournissez un identifiant utilisateur unique.

messages
object[]
requis

Tableau des messages de la conversation. Utilisez la fonction handleSubmit du hook useChat du package @ai-sdk/react pour gérer les messages et les réponses en streaming.

threadId
string

Identifiant optionnel utilisé pour maintenir la continuité de la conversation sur plusieurs messages. Lorsqu’il est fourni, il permet au système de rattacher les messages suivants au même fil de conversation. Le threadId est renvoyé dans la réponse sous la forme event.threadId lorsque event.type === 'finish'.

retrievalPageSize
number
défaut:5

Nombre de résultats de recherche dans la documentation à utiliser pour générer la réponse. Des valeurs plus élevées fournissent davantage de contexte, mais peuvent augmenter le temps de réponse. Valeur recommandée�a0: 5.

filter
object

Critères de filtrage facultatifs pour la recherche.

context
object[]

Tableau facultatif d’informations contextuelles à fournir à l’Assistant.

currentPath
string

Chemin de la page que l’utilisateur consulte actuellement. Lorsqu’il est fourni, l’Assistant utilise ce contexte pour donner des réponses plus pertinentes. Longueur maximale : 200 caractères.

Réponse

Message généré avec succès

Réponse en streaming compatible avec AI SDK v5. Utilisez le hook useChat de @ai-sdk/react pour gérer le streaming de la réponse.