Passer au contenu principal
POST
/
search
/
{domain}
Rechercher dans la documentation
curl --request POST \
  --url https://api-dsc.mintlify.com/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'
[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

Authorizations

Authorization
string
header
required

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

Path Parameters

domain
string
required

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

Body

application/json
query
string
required

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

pageSize
number
default:10

Nombre de résultats de recherche à renvoyer. Par défaut, 10 si aucune valeur n’est spécifiée.

filter
object

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

Response

200 - application/json

Résultats de recherche

content
string

Le contenu correspondant tiré de votre documentation.

path
string

Le chemin ou l’URL vers le document source.

metadata
object

Des métadonnées supplémentaires sur le résultat de recherche.