Rechercher dans la documentation

Effectuez des recherches de manière programmatique dans votre documentation et récupérez les pages pertinentes correspondant à la requête.

POST /v1/search/{domain}

Rechercher dans la documentation

cURL

curl --request POST \
  --url https://api.mintlify.com/discovery/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "scoreThreshold": 0.5,
  "filter": {
    "version": "<string>",
    "language": "<string>",
    "tag": "<string>"
  }
}
'

200

[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

​

Limites de débit

• 10 000 requêtes par organisation Mintlify par heure

Autorisations

Authorization · string · header · requis

L’en-tête Authorization attend un jeton Bearer. Utilisez une clé d’API Assistant (préfixée par mint_dsc_). Il s’agit d’une clé publique, que vous pouvez utiliser en toute sécurité dans du code côté client. Générez-en une sur la page API keys de votre Dashboard.

Paramètres de chemin

domain · string · requis

L’identifiant de domaine extrait de votre URL domain.mintlify.app. Il se trouve à la fin de l’URL de votre Dashboard. Par exemple, dans dashboard.mintlify.com/organization/domain, l’identifiant de domaine est domain.

Corps

application/json

query · string · requis

La requête de recherche à exécuter sur le contenu de votre documentation.

pageSize · integer · défaut: 10

Nombre de résultats de recherche à retourner. Doit être compris entre 1 et 50. La valeur par défaut est 10 si aucune valeur n’est spécifiée.

Plage requise: 1 <= x <= 50

scoreThreshold · number

Score de pertinence minimal pour les résultats. Seuls les résultats ayant un score supérieur ou égal à ce seuil sont renvoyés. Doit être compris entre 0 et 1.

Plage requise: 0 <= x <= 1

filter · object

Paramètres de filtrage optionnels permettant de restreindre les résultats de recherche.

Show child attributes

Réponse

200 - application/json

Résultats de recherche

content · string

Le contenu correspondant issu de votre documentation.

path · string

Le chemin d’accès ou l’URL du document source.

metadata · object

Metadata supplémentaires relatives au résultat de recherche.