Buscar en la documentación

Realiza búsquedas semánticas y por palabras clave en tu documentación, con filtros y paginación configurables.

POST /search/{domain}

Buscar en la documentación

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": {}
  }
]

Autorizaciones

Authorization · string · header · requerido

El encabezado Authorization requiere un token Bearer. Consulta la documentación de la clave de la Assistant API para saber cómo obtener tu clave de API.

Parámetros de ruta

domain · string · requerido

El identificador de dominio de tu URL domain.mintlify.app. Puedes encontrarlo al final de la URL de tu dashboard. Por ejemplo, dashboard.mintlify.com/organization/domain tiene un identificador de dominio de domain.

Cuerpo

application/json

query · string · requerido

La búsqueda que se ejecutará en el contenido de tu documentación.

pageSize · number · predeterminado: 10

Número de resultados de búsqueda que se devolverán. Si no se especifica, el valor predeterminado es 10.

filter · object

Parámetros de filtrado opcionales para refinar los resultados de búsqueda.

Mostrar atributos secundarios

Respuesta

200 - application/json

Resultados de búsqueda

content · string

El contenido correspondiente de tu documentación.

path · string

Ruta o URL al documento de origen.

metadata · object

Metadatos adicionales sobre el resultado de la búsqueda.