mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
b4c08f5597
- Updated discovery-openapi.json - Updated es/admin-openapi.json - Updated es/discovery-openapi.json - Updated fr/admin-openapi.json - Updated fr/discovery-openapi.json - Updated zh/admin-openapi.json - Updated zh/discovery-openapi.json - Updated api/introduction.mdx - Updated admin-openapi.json - Updated openapi.json - Updated es/api/introduction.mdx - Updated fr/api/introduction.mdx - Updated zh/api/introduction.mdx - Deleted api/agent/create-agent-job.mdx - Deleted api/agent/get-agent-job.mdx - Deleted api/agent/get-all-jobs.mdx - Deleted api/agent/v2/create-agent-job.mdx - Deleted api/agent/v2/get-agent-job.mdx - Deleted api/agent/v2/send-message.mdx - Deleted api/analytics/assistant-caller-stats.mdx - Deleted api/analytics/assistant-conversations.mdx - Deleted api/analytics/feedback-by-page.mdx - Deleted api/analytics/feedback.mdx - Deleted api/analytics/searches.mdx - Deleted api/analytics/views.mdx - Deleted api/analytics/visitors.mdx - Deleted api/assistant/create-assistant-message-v2.mdx - Deleted api/assistant/create-assistant-message.mdx - Deleted api/assistant/get-page-content.mdx - Deleted api/assistant/search.mdx - Deleted api/preview/trigger.mdx - Deleted api/update/status.mdx - Deleted api/update/trigger.mdx - Deleted es/api/agent/create-agent-job.mdx - Deleted es/api/agent/get-agent-job.mdx - Deleted es/api/agent/get-all-jobs.mdx - Deleted es/api/agent/v2/create-agent-job.mdx - Deleted es/api/agent/v2/get-agent-job.mdx - Deleted es/api/agent/v2/send-message.mdx - Deleted es/api/analytics/assistant-caller-stats.mdx - Deleted es/api/analytics/assistant-conversations.mdx - Deleted es/api/analytics/feedback-by-page.mdx - Deleted es/api/analytics/feedback.mdx - Deleted es/api/analytics/searches.mdx - Deleted es/api/analytics/views.mdx - Deleted es/api/analytics/visitors.mdx - Deleted es/api/assistant/create-assistant-message-v2.mdx - Deleted es/api/assistant/create-assistant-message.mdx - Deleted es/api/assistant/get-page-content.mdx - Deleted es/api/assistant/search.mdx - Deleted es/api/preview/trigger.mdx - Deleted es/api/update/status.mdx - Deleted es/api/update/trigger.mdx - Deleted fr/api/agent/create-agent-job.mdx - Deleted fr/api/agent/get-agent-job.mdx - Deleted fr/api/agent/get-all-jobs.mdx - Deleted fr/api/agent/v2/create-agent-job.mdx - Deleted fr/api/agent/v2/get-agent-job.mdx - Deleted fr/api/agent/v2/send-message.mdx - Deleted fr/api/analytics/assistant-caller-stats.mdx - Deleted fr/api/analytics/assistant-conversations.mdx - Deleted fr/api/analytics/feedback-by-page.mdx - Deleted fr/api/analytics/feedback.mdx - Deleted fr/api/analytics/searches.mdx - Deleted fr/api/analytics/views.mdx - Deleted fr/api/analytics/visitors.mdx - Deleted fr/api/assistant/create-assistant-message-v2.mdx - Deleted fr/api/assistant/create-assistant-message.mdx - Deleted fr/api/assistant/get-page-content.mdx - Deleted fr/api/assistant/search.mdx - Deleted fr/api/preview/trigger.mdx - Deleted fr/api/update/status.mdx - Deleted fr/api/update/trigger.mdx - Deleted zh/api/agent/create-agent-job.mdx - Deleted zh/api/agent/get-agent-job.mdx - Deleted zh/api/agent/get-all-jobs.mdx - Deleted zh/api/agent/v2/create-agent-job.mdx - Deleted zh/api/agent/v2/get-agent-job.mdx - Deleted zh/api/agent/v2/send-message.mdx - Deleted zh/api/analytics/assistant-caller-stats.mdx - Deleted zh/api/analytics/assistant-conversations.mdx - Deleted zh/api/analytics/feedback-by-page.mdx - Deleted zh/api/analytics/feedback.mdx - Deleted zh/api/analytics/searches.mdx - Deleted zh/api/analytics/views.mdx - Deleted zh/api/analytics/visitors.mdx - Deleted zh/api/assistant/create-assistant-message-v2.mdx - Deleted zh/api/assistant/create-assistant-message.mdx - Deleted zh/api/assistant/get-page-content.mdx - Deleted zh/api/assistant/search.mdx - Deleted zh/api/preview/trigger.mdx - Deleted zh/api/update/status.mdx - Deleted zh/api/update/trigger.mdx - Updated docs.json - Updated es.json - Updated fr.json - Updated zh.json Mintlify-Source: dashboard-editor
68 lines
5.5 KiB
Plaintext
68 lines
5.5 KiB
Plaintext
---
|
|
title: "Introducción"
|
|
description: "Usa la API REST de Mintlify para lanzar despliegues, integrar un asistente de IA, exportar datos de Analytics y gestionar la documentación de forma programática."
|
|
keywords: ["REST API", "endpoints", "API keys"]
|
|
boost: 3
|
|
---
|
|
|
|
La REST (Representational State Transfer) API de Mintlify te permite interactuar de forma programática con tu documentación, lanzar actualizaciones, integrar experiencias de chat impulsadas por IA y exportar datos de Analytics.
|
|
|
|
<div id="endpoints">
|
|
## Endpoints
|
|
</div>
|
|
|
|
- [Trigger update](/es/api/admin/trigger-update): Activa una actualización de tu sitio cuando quieras.
|
|
- [Get update status](/es/api/admin/get-update-status): Obtén el estado de una actualización y otros detalles de tu documentación.
|
|
- [Trigger preview deployment](/es/api/admin/trigger-preview-deployment): Crea o actualiza una implementación de vista previa para una rama específica.
|
|
- [Create agent job](/es/api/agent/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente.
|
|
- [Get agent job](/es/api/agent/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica.
|
|
- [Send follow-up message](/es/api/agent/send-follow-up-message): Envía un mensaje de seguimiento a una tarea de agente existente.
|
|
- [Create assistant message](/es/api/assistant/create-assistant-message): Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas.
|
|
- [Search documentation](/es/api/assistant/search-documentation): Busca en tu documentación.
|
|
- [Get page content](/es/api/assistant/get-page-content): Recupera el contenido de texto completo de una página de documentación.
|
|
- [Get user feedback](/es/api/analytics/get-feedback): Exporta los comentarios de los usuarios de tu documentación.
|
|
- [Get assistant conversations](/es/api/analytics/get-assistant-conversations): Exporta el historial de conversaciones del Asistente de IA.
|
|
- [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats): Obtén un desglose de los recuentos de consultas del assistant por tipo de origen.
|
|
|
|
<div id="common-use-cases">
|
|
### Casos de uso comunes
|
|
</div>
|
|
|
|
- **Implementaciones automatizadas**: Activa actualizaciones del sitio a intervalos establecidos o cuando se produzcan eventos con [Trigger update](/es/api/admin/trigger-update) y [Get update status](/es/api/admin/get-update-status).
|
|
- **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/admin/trigger-update).
|
|
- **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/admin/trigger-preview-deployment).
|
|
- **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message), [Search documentation](/es/api/assistant/search-documentation) y [Get page content](/es/api/assistant/get-page-content).
|
|
- **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/create-agent-job), [Get agent job](/es/api/agent/get-agent-job) y [Send follow-up message](/es/api/agent/send-follow-up-message).
|
|
- **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/get-feedback), [Get assistant conversations](/es/api/analytics/get-assistant-conversations) y [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats).
|
|
|
|
<div id="authentication">
|
|
## Autenticación
|
|
</div>
|
|
|
|
Puedes generar API keys en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. Cada API key pertenece a una organización; puedes usar API keys en múltiples implementaciones dentro de la misma organización.
|
|
|
|
Puedes crear hasta 10 API keys por hora y por organización.
|
|
|
|
<div id="admin-api-key">
|
|
### Clave de la API de administrador
|
|
</div>
|
|
|
|
Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/admin/trigger-update), [Get update status](/es/api/admin/get-update-status), [Trigger preview deployment](/es/api/admin/trigger-preview-deployment), [Create agent job](/es/api/agent/create-agent-job), [Get agent job](/es/api/agent/get-agent-job), [Send follow-up message](/es/api/agent/send-follow-up-message), [Get user feedback](/es/api/analytics/get-feedback), [Get assistant conversations](/es/api/analytics/get-assistant-conversations) y [Get assistant caller stats](/es/api/analytics/get-assistant-caller-stats).
|
|
|
|
Las claves de la API de administrador comienzan con el prefijo `mint_`.
|
|
|
|
La clave de la API de administrador es un secreto del lado del servidor. No la expongas en código del lado del cliente.
|
|
|
|
<div id="assistant-api-key">
|
|
### key del Assistant API
|
|
</div>
|
|
|
|
Usa la key del Assistant API para autenticar solicitudes a los endpoints [Create assistant message](/es/api/assistant/create-assistant-message), [Search documentation](/es/api/assistant/search-documentation) y [Get page content](/es/api/assistant/get-page-content).
|
|
|
|
Las keys del Assistant API comienzan con el prefijo `mint_dsc_`.
|
|
|
|
La key del Assistant API es un token público que puede referenciarse en tu código de frontend.
|
|
|
|
<Note>
|
|
Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del assistant o incurriendo en excedentes.
|
|
</Note> |