Saltar al contenido principal
POST
/
search
/
{domain}
Buscar en la documentación
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

El encabezado Authorization requiere un token Bearer. Consulta la documentación de la clave de API del assistant para obtener más detalles sobre cómo obtener tu clave de API.

Path Parameters

​
domain
string
required

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 como identificador de dominio domain.

Body

application/json
​
query
string
required

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

​
pageSize
number
default:10

Número de resultados de búsqueda que se devolverán. El valor predeterminado es 10 si no se especifica.

​
filter
object

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

Response

200 - application/json

Resultados de búsqueda

​
content
string

El contenido correspondiente de tu documentación.

​
path
string

La ruta o URL del documento de origen.

​
metadata
object

Metadata adicional sobre el resultado de la búsqueda.