Buscar en la documentación

Busca en tu documentación de forma programática y obtén las páginas relevantes que coincidan con la búsqueda.

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

200

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

​

Límites de tasa

• 10,000 solicitudes por organización de Mintlify por hora

Autorizaciones

Authorization · string · header · requerido

La cabecera Authorization espera un token de tipo Bearer. Usa una clave de API para assistant (con el prefijo mint_dsc_). Esta es una clave pública segura para utilizar en código del lado del cliente. Genérala desde la página de claves de API de tu dashboard.

Parámetros de ruta

domain · string · requerido

El identificador domain de tu URL domain.mintlify.app. Lo puedes encontrar al final de la URL de tu dashboard. Por ejemplo, dashboard.mintlify.com/organization/domain tiene un identificador domain de domain.

Cuerpo

application/json

query · string · requerido

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

pageSize · integer · predeterminado: 10

Número de resultados de búsqueda que se mostrarán. Debe estar entre 1 y 50. De forma predeterminada es 10 si no se especifica.

Rango requerido: 1 <= x <= 50

scoreThreshold · number

Puntuación mínima de relevancia para los resultados. Solo se devuelven los resultados con una puntuación igual o superior a este umbral. Debe estar entre 0 y 1.

Rango requerido: 0 <= x <= 1

filter · object

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

Show child attributes

Respuesta

200 - application/json

Resultados de la búsqueda

content · string

El contenido de tu documentación que coincide con la búsqueda.

path · string

La ruta o URL del documento de origen.

metadata · object

Metadata adicional sobre el resultado de la búsqueda.