Referencia de la API
La API HTTP de Sypnia: una sola API para el motor de código abierto y para Sypnia Cloud, con cada endpoint, parámetro, respuesta y error.
En esta página
Motor Nube Todo lo que Sypnia sabe de tu app está en esta API: los problemas con su causa, las sesiones y sus grabaciones, las trazas, el rendimiento, la disponibilidad, las alertas. La app, la Consola, el servidor MCP y la CLI están hechos sobre ella, así que todo lo que muestran lo puede leer tu propio código.
Es la misma API en un motor alojado por ti y en Sypnia Cloud. Un endpoint que existe solo en uno lo dice con una insignia.
curl "https://api.sypnia.com/v1/problems?status=open" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"| URL base | https://api.sypnia.com/v1 en Sypnia Cloud, <tu URL base>/v1 en tu motor |
| Credenciales | Un token de API (sps_…) para leer y administrar; una llave de ingesta (spk_…) para enviar; el token raíz en tu propio motor |
| Formato | JSON de entrada y de salida. Fechas en UTC |
| Contrato | spec/openapi.yaml en el repositorio de la documentación, OpenAPI 3.1. Estas páginas se generan a partir de él |
Los nombres de endpoints, parámetros, campos y valores están en inglés y no se traducen. Los ejemplos de respuestas muestran los datos tal como los devuelve la API.
Empieza aquí
- La URL base, las tres credenciales y sus permisos, y los endpoints que cubren todo un proyecto.
- La única forma de error, los límites de peticiones, los cursores, los rangos de tiempo, la idempotencia, las versiones de la API.
Leer
- Lista problemas, trae uno con todo su contexto, el prompt listo, y márcalo como resuelto.
- Sesiones, su línea de tiempo, su grabación, personas y cuentas.
- Una petición, del navegador a las llamadas detrás de la API.
- Métricas de páginas, llamadas a la API, mapas de clics, fallas de formularios, sugerencias semanales.
- Comprobaciones, su estado y sus resultados.
- Alertas, las reglas que las crean y webhooks firmados.
Enviar y administrar
- El protocolo que hablan los SDK, para tu propio cliente.
- Trazas de OpenTelemetry por HTTP.
- Registra una versión y sube sus source maps.
- Proyectos, llaves de ingesta, tokens de API y uso.