Skip to content
Mintlify
Mintlify
Mintlify Index

API REST de Mintlify Index

Usa la API REST de Mintlify Index para buscar en la documentación y la web, reunir contexto con fuentes citadas y recuperar contenido de páginas.

Usa la API REST de Mintlify Index para recuperar conocimientos técnicos para aplicaciones y agentes. La API admite tres patrones de recuperación:

  • context reúne contenido con fuentes citadas dentro de un presupuesto de tokens.
  • search devuelve resultados clasificados de documentación y la web.
  • contents recupera contenido para los ID de resultados de Mintlify o las URL de resultados seleccionados.

La API REST requiere una clave de API para tu organización. El servidor MCP de Index público no requiere una clave de API.

Envía las solicitudes a la API REST a:

https://leaves.mintlify.com/api/universal-search/v1

Añade una ruta de endpoint a esta URL base, por ejemplo /context, /search o /contents.

Autentica cada solicitud con una clave de API de Index en el encabezado Authorization:

Authorization: Bearer mint_us_...

Las claves de API de Index comienzan por mint_us_.

Crear una clave de API de Index

Abre la página de claves de API en tu dashboard y crea una clave de API de Index.

Guardar la clave de forma segura

Guarda la clave en una variable de entorno del lado del servidor. Mintlify solo muestra la clave completa cuando la creas por primera vez. Guárdala de forma segura.

export MINTLIFY_INDEX_API_KEY="mint_us_..."

No expongas una clave de API de Index en código del lado del cliente ni la confirmes en el control de versiones.

Crear contexto

Envía tu primera solicitud al endpoint context:

curl -X POST "https://leaves.mintlify.com/api/universal-search/v1/context" \
  -H "Authorization: Bearer $MINTLIFY_INDEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How should I configure caching in Next.js 16?",
    "product": "Next.js",
    "format": "txt",
    "tokenBudget": 3000
  }'

Una respuesta correcta incluye el contexto reunido con las URL de las fuentes, el número de resultados utilizados y el recuento de tokens de salida.

Los límites de la API REST se aplican por organización de Mintlify. Todas las claves de API de una organización comparten el mismo límite:

VentanaLímite
Por segundo10 solicitudes
Por día1.000 solicitudes

Las solicitudes que superan cualquiera de los límites devuelven 429 Too Many Requests. Usa un backoff exponencial antes de volver a intentarlo.

EstadoSignificado
400El cuerpo de la solicitud no es válido.
401Falta la clave de API o no es válida.
403La IP de la solicitud no está permitida por la clave de API.
429La organización superó un límite de uso.
500Index no pudo completar la solicitud.
Was this page helpful?Suggest editsRaise issue