Rechercher dans la documentation

Effectuez des recherches sémantiques et par mots-clés dans votre documentation, avec filtrage et pagination configurables.

POST /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,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'

200

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

Authorizations

Authorization · string · header · required

L’en-tête Authorization requiert un jeton Bearer. Consultez la documentation sur la clé d’API de l’Assistant pour savoir comment obtenir votre clé d’API.

Path Parameters

domain · string · required

L’identifiant de domaine à partir de votre URL domain.mintlify.app. Vous pouvez le trouver à la fin de l’URL de votre Dashboard. Par exemple, dashboard.mintlify.com/organization/domain a pour identifiant de domaine domain.

Body

application/json

query · string · required

La requête de recherche à effectuer sur le contenu de votre documentation.

pageSize · number · default: 10

Nombre de résultats de recherche à renvoyer. La valeur par défaut est 10 si non spécifié.

filter · object

Paramètres de filtrage facultatifs pour affiner les résultats de recherche.

Afficher attributs enfants

filter. version · string

Filtrez les résultats par version de la documentation.

filter. language · string

Filtrer les résultats par langue du contenu.

Response

200 - application/json

Résultats de recherche

content · string

Le contenu correspondant dans votre documentation.

path · string

Le chemin ou l’URL vers le document source.

metadata · object

Des métadonnées supplémentaires relatives au résultat de recherche.