Proyectos, llaves y tokens
Crea proyectos, llaves de ingesta y tokens de API en un motor alojado por ti, administra llaves y tokens en cualquier parte, y lee el uso.
En esta página
- El objeto proyecto
- El objeto llave de ingesta
- El objeto token de API
- Listar proyectos
- Crear un proyecto
- Traer un proyecto
- Actualizar un proyecto
- Borrar un proyecto
- Listar llaves de ingesta
- Crear una llave de ingesta
- Revocar una llave de ingesta
- Listar tokens de API
- Crear un token de API
- Revocar un token de API
- Traer el uso y los límites
El motor sabe tres cosas sobre el acceso: proyectos, llaves de ingesta y tokens de API. No tiene usuarios ni organizaciones. Esos existen solo en Sypnia Cloud, en la app, y no tienen API pública al lanzar.
| Quieres | Motor (alojamiento propio) | Sypnia Cloud |
|---|---|---|
| Crear o borrar un proyecto | Esta API, con el token raíz | En la app |
| Crear o revocar llaves de ingesta y tokens de API | Esta API, con el token raíz o un token admin del proyecto | Esta API con un token admin, o en la app |
| Invitar personas, cambiar de plan, ver facturas | No existe | En la app |
El objeto proyecto
Campos
-
idstring opcionalprj_…. -
slugstring opcionalUn nombre corto para URLs y comandos. Letras minúsculas, dígitos y guiones, de 2 a 40 caracteres. No se puede cambiar.
-
namestring opcionalEl nombre que ve la gente.
-
timezonestring opcionalUna zona horaria IANA. Los días, «hoy» y «ayer» se cortan en ella.
-
environmentslista de string opcionalLos entornos que enviaron datos en los últimos 30 días.
-
settingsobject opcional -
settings.allowed_originslista de string, hasta 50 elementosOrígenes que pueden enviar datos desde un navegador, como
https://shop.example.com. Un*.al comienzo acepta subdominios. Vacío acepta cualquier origen. -
settings.replayobjectReglas de grabación. El SDK las lee de la llamada de configuración de la ingesta.
-
settings.replay.enabledbooleanfalseapaga la grabación en el proyecto.Por defecto:
true -
settings.replay.sample_ratenumber, 0 a 1La parte de las sesiones que se graba desde su primer momento. Las demás igual se graban desde 30 segundos antes de su primer error, clic de rabia o clic muerto.
Por defecto:
0.1 -
settings.replay.mask_all_textbooleantrueenmascara todo el texto de la página, no solo lo que la gente escribe. Lo que la gente escribe siempre se enmascara, y los campos de contraseña, de tarjeta y de código de un solo uso nunca se pueden mostrar.Por defecto:
false -
settings.replay.blocked_routeslista de string, hasta 100 elementosRutas donde no se graba nada ni se toma ninguna captura.
*vale por cualquier texto:/account/*. -
settings.replay.always_recordlista de object, hasta 100 elementosPersonas y cuentas cuyas sesiones se graban siempre desde el comienzo, por ejemplo mientras ayudas a un cliente.
-
settings.snapshotsobject -
settings.snapshots.sample_ratenumber, 0 a 1La parte de las sesiones que toma capturas de página, para los mapas de clics.
Por defecto:
0.5 -
settings.agentobject -
settings.agent.enabledbooleanfalseapaga el agente en este proyecto: sin análisis y sin sugerencias semanales hechas por un modelo. No se envía nada a un proveedor de IA.Por defecto:
true -
settings.agent.languagestringEl idioma en el que escribe el agente, como etiqueta BCP 47 (
en,es).Por defecto:
en -
settings.agent.auto_pull_requestsstringSolo en Sypnia Cloud.
high_confidenceabre un pull request por su cuenta cuando un análisis eshigh. Uno de:off,high_confidence.Por defecto:
off -
created_attimestamp opcional
El objeto llave de ingesta
Campos
-
idstring opcionalEl id del registro,
key_…. Úsalo para revocar la llave. -
keystring opcionalLa llave misma,
spk_y 32 caracteres hexadecimales. Es pública: va en el código de tu app. -
namestring opcional -
rate_limit_per_minuteinteger opcionalPeticiones por minuto que se aceptan desde una misma dirección con esta llave.
-
created_attimestamp opcional -
last_used_attimestamp o null opcionalCon precisión de una hora.
-
revoked_attimestamp o null opcional
El objeto token de API
Campos
-
idstring opcionalEl id del registro,
tok_…. Úsalo para revocar el token. -
namestring opcional -
prefixstring opcionalLos primeros 12 caracteres del secreto.
-
scopeslista de string opcionalUno de:
read,replay,admin. -
created_attimestamp opcional -
last_used_attimestamp o null opcionalCon precisión de una hora.
-
expires_attimestamp o null opcional -
revoked_attimestamp o null opcional
Listar proyectos
/v1/projects MotorNube Con el token raíz, todos los proyectos del motor. Con un token de API, una lista con el único proyecto al que pertenece el token.
Parámetros de consulta
-
limitinteger, 1 a 200 opcionalMáximo de elementos que se devuelven.
Por defecto:
50 -
cursorstring opcionalEl
next_cursorde la página anterior. Deja iguales todos los demás parámetros.
Petición
curl "https://sypnia.example.com/v1/projects" \
-H "Authorization: Bearer $SYPNIA_ROOT_TOKEN"Respuesta200
{
"data": [
{
"id": "prj_5k2m9x4q7w1z",
"slug": "shop",
"name": "Shop",
"timezone": "UTC",
"environments": [
"production",
"development"
],
"settings": {
"allowed_origins": [
"https://shop.example.com"
],
"replay": {
"enabled": true,
"sample_rate": 0.1,
"mask_all_text": false,
"blocked_routes": [
"/account/cards"
],
"always_record": [
{
"person": "u_1042",
"note": "Reported the checkout bug",
"until": "2026-03-26T00:00:00Z"
}
]
},
"snapshots": {
"sample_rate": 0.5
},
"agent": {
"enabled": true,
"language": "en",
"auto_pull_requests": "off"
}
},
"created_at": "2026-02-02T09:15:00Z"
}
],
"next_cursor": null
}Crear un proyecto
/v1/projects Motor Crea un proyecto y su primera llave de ingesta, que vuelve en ingest_key. Solo en motores alojados por ti: en Sypnia Cloud los proyectos se crean en la app, donde pertenecen a una organización y a un plan, y esta llamada responde 403 cloud_managed.
Encabezados
-
Idempotency-Keystring, hasta 255 caracteres opcionalUn valor tuyo, de 1 a 255 caracteres, que hace que la llamada se pueda repetir sin riesgo. Mira idempotencia.
Cuerpo
-
namestring, hasta 80 caracteres obligatorioEl nombre que ve la gente.
-
slugstring opcionalPor defecto, el nombre en minúsculas con guiones.
-
timezonestring opcionalUna zona horaria IANA, como
America/Bogota.Por defecto:
UTC -
settingsobject opcional -
settings.allowed_originslista de string, hasta 50 elementosOrígenes que pueden enviar datos desde un navegador, como
https://shop.example.com. Un*.al comienzo acepta subdominios. Vacío acepta cualquier origen. -
settings.replayobjectReglas de grabación. El SDK las lee de la llamada de configuración de la ingesta.
-
settings.replay.enabledbooleanfalseapaga la grabación en el proyecto.Por defecto:
true -
settings.replay.sample_ratenumber, 0 a 1La parte de las sesiones que se graba desde su primer momento. Las demás igual se graban desde 30 segundos antes de su primer error, clic de rabia o clic muerto.
Por defecto:
0.1 -
settings.replay.mask_all_textbooleantrueenmascara todo el texto de la página, no solo lo que la gente escribe. Lo que la gente escribe siempre se enmascara, y los campos de contraseña, de tarjeta y de código de un solo uso nunca se pueden mostrar.Por defecto:
false -
settings.replay.blocked_routeslista de string, hasta 100 elementosRutas donde no se graba nada ni se toma ninguna captura.
*vale por cualquier texto:/account/*. -
settings.replay.always_recordlista de object, hasta 100 elementosPersonas y cuentas cuyas sesiones se graban siempre desde el comienzo, por ejemplo mientras ayudas a un cliente.
-
settings.snapshotsobject -
settings.snapshots.sample_ratenumber, 0 a 1La parte de las sesiones que toma capturas de página, para los mapas de clics.
Por defecto:
0.5 -
settings.agentobject -
settings.agent.enabledbooleanfalseapaga el agente en este proyecto: sin análisis y sin sugerencias semanales hechas por un modelo. No se envía nada a un proveedor de IA.Por defecto:
true -
settings.agent.languagestringEl idioma en el que escribe el agente, como etiqueta BCP 47 (
en,es).Por defecto:
en -
settings.agent.auto_pull_requestsstringSolo en Sypnia Cloud.
high_confidenceabre un pull request por su cuenta cuando un análisis eshigh. Uno de:off,high_confidence.Por defecto:
off
Petición
curl -X POST "https://sypnia.example.com/v1/projects" \
-H "Authorization: Bearer $SYPNIA_ROOT_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Shop", "slug": "shop", "timezone": "UTC"}'Respuesta201
{
"id": "prj_5k2m9x4q7w1z",
"slug": "shop",
"name": "Shop",
"timezone": "UTC",
"environments": [],
"settings": {
"allowed_origins": [],
"replay": {
"enabled": true,
"sample_rate": 0.1,
"mask_all_text": false,
"blocked_routes": [],
"always_record": []
},
"snapshots": {
"sample_rate": 0.5
},
"agent": {
"enabled": true,
"language": "en",
"auto_pull_requests": "off"
}
},
"created_at": "2026-02-02T09:15:00Z",
"ingest_key": {
"id": "key_3n8v2c6b1m4x",
"key": "spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e",
"name": "Default",
"rate_limit_per_minute": 600,
"created_at": "2026-02-02T09:15:00Z",
"last_used_at": null,
"revoked_at": null
}
}Errores
- 400
invalid_requestFalta
name,slugtiene caracteres distintos dea-z 0-9 -, otimezoneno es un nombre IANA. - 403
cloud_managedLa petición llegó a Sypnia Cloud. Crea los proyectos en la app.
- 403
forbiddenLa credencial no es el token raíz.
- 409
conflictYa existe un proyecto con este
slug.
Traer un proyecto
/v1/projects/{project_ref} MotorNube Un proyecto con sus ajustes.
Parámetros de ruta
-
project_refstring obligatorioEl id del proyecto (
prj_…) o su slug.
Petición
curl "https://api.sypnia.com/v1/projects/shop" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"Respuesta200
{
"id": "prj_5k2m9x4q7w1z",
"slug": "shop",
"name": "Shop",
"timezone": "UTC",
"environments": [
"production",
"development"
],
"settings": {
"allowed_origins": [
"https://shop.example.com"
],
"replay": {
"enabled": true,
"sample_rate": 0.1,
"mask_all_text": false,
"blocked_routes": [
"/account/cards"
],
"always_record": [
{
"person": "u_1042",
"note": "Reported the checkout bug",
"until": "2026-03-26T00:00:00Z"
}
]
},
"snapshots": {
"sample_rate": 0.5
},
"agent": {
"enabled": true,
"language": "en",
"auto_pull_requests": "off"
}
},
"created_at": "2026-02-02T09:15:00Z"
}Errores
- 404
not_foundNo existe ese proyecto, o el token es de otro.
Actualizar un proyecto
/v1/projects/{project_ref} MotorNube Cambia los campos que envías y deja los demás. settings se mezcla clave por clave: envía solo los ajustes que quieres cambiar. Las reglas de grabación (settings.replay, settings.snapshots) llegan a los navegadores con su siguiente sesión, por la llamada de configuración de la ingesta; no hace falta desplegar.
Parámetros de ruta
-
project_refstring obligatorioEl id del proyecto (
prj_…) o su slug.
Cuerpo
-
namestring, hasta 80 caracteres opcionalEl nombre que ve la gente.
-
timezonestring opcionalUna zona horaria IANA. Los días pasados no se vuelven a cortar.
-
settingsobject opcional -
settings.allowed_originslista de string, hasta 50 elementosOrígenes que pueden enviar datos desde un navegador, como
https://shop.example.com. Un*.al comienzo acepta subdominios. Vacío acepta cualquier origen. -
settings.replayobjectReglas de grabación. El SDK las lee de la llamada de configuración de la ingesta.
-
settings.replay.enabledbooleanfalseapaga la grabación en el proyecto.Por defecto:
true -
settings.replay.sample_ratenumber, 0 a 1La parte de las sesiones que se graba desde su primer momento. Las demás igual se graban desde 30 segundos antes de su primer error, clic de rabia o clic muerto.
Por defecto:
0.1 -
settings.replay.mask_all_textbooleantrueenmascara todo el texto de la página, no solo lo que la gente escribe. Lo que la gente escribe siempre se enmascara, y los campos de contraseña, de tarjeta y de código de un solo uso nunca se pueden mostrar.Por defecto:
false -
settings.replay.blocked_routeslista de string, hasta 100 elementosRutas donde no se graba nada ni se toma ninguna captura.
*vale por cualquier texto:/account/*. -
settings.replay.always_recordlista de object, hasta 100 elementosPersonas y cuentas cuyas sesiones se graban siempre desde el comienzo, por ejemplo mientras ayudas a un cliente.
-
settings.snapshotsobject -
settings.snapshots.sample_ratenumber, 0 a 1La parte de las sesiones que toma capturas de página, para los mapas de clics.
Por defecto:
0.5 -
settings.agentobject -
settings.agent.enabledbooleanfalseapaga el agente en este proyecto: sin análisis y sin sugerencias semanales hechas por un modelo. No se envía nada a un proveedor de IA.Por defecto:
true -
settings.agent.languagestringEl idioma en el que escribe el agente, como etiqueta BCP 47 (
en,es).Por defecto:
en -
settings.agent.auto_pull_requestsstringSolo en Sypnia Cloud.
high_confidenceabre un pull request por su cuenta cuando un análisis eshigh. Uno de:off,high_confidence.Por defecto:
off
Petición
curl -X PATCH "https://api.sypnia.com/v1/projects/shop" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"settings": {"replay": {"blocked_routes": ["/account/cards"]}}}'Respuesta200
{
"id": "prj_5k2m9x4q7w1z",
"slug": "shop",
"name": "Shop",
"timezone": "UTC",
"environments": [
"production",
"development"
],
"settings": {
"allowed_origins": [
"https://shop.example.com"
],
"replay": {
"enabled": true,
"sample_rate": 0.1,
"mask_all_text": false,
"blocked_routes": [
"/account/cards"
],
"always_record": [
{
"person": "u_1042",
"note": "Reported the checkout bug",
"until": "2026-03-26T00:00:00Z"
}
]
},
"snapshots": {
"sample_rate": 0.5
},
"agent": {
"enabled": true,
"language": "en",
"auto_pull_requests": "off"
}
},
"created_at": "2026-02-02T09:15:00Z"
}Errores
- 400
invalid_requestUn ajuste está fuera de rango o no existe.
paramlo nombra, por ejemplosettings.replay.sample_rate. - 404
not_foundNo existe ese proyecto, o el token es de otro.
Borrar un proyecto
/v1/projects/{project_ref} Motor Borra para siempre el proyecto, sus llaves y tokens, y todos sus datos. La ingesta con sus llaves se detiene de inmediato; los objetos guardados se quitan en menos de 24 horas. Solo en motores alojados por ti. Para confirmar, envía el slug del proyecto en el parámetro confirm.
Parámetros de ruta
-
project_refstring obligatorioEl id del proyecto (
prj_…) o su slug.
Parámetros de consulta
-
confirmstring obligatorioEl slug del proyecto, escrito otra vez.
Petición
curl -X DELETE "https://sypnia.example.com/v1/projects/shop?confirm=shop" \
-H "Authorization: Bearer $SYPNIA_ROOT_TOKEN"Errores
- 400
invalid_requestFalta
confirmo no es el slug del proyecto. - 403
cloud_managedLa petición llegó a Sypnia Cloud. Borra los proyectos en la app.
- 404
not_foundNo existe ese proyecto.
Listar llaves de ingesta
/v1/keys MotorNube Las llaves de ingesta del proyecto, incluidas las revocadas. Una llave de ingesta es pública, así que la lista muestra cada llave completa.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Petición
curl "https://api.sypnia.com/v1/keys" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"Respuesta200
{
"data": [
{
"id": "key_3n8v2c6b1m4x",
"key": "spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e",
"name": "Web app",
"rate_limit_per_minute": 600,
"created_at": "2026-02-02T09:15:00Z",
"last_used_at": "2026-03-12T10:31:58Z",
"revoked_at": null
}
],
"next_cursor": null
}Crear una llave de ingesta
/v1/keys MotorNube Crea otra llave de ingesta para el proyecto. Dale a cada app o plataforma su propia llave (web, móvil, servidor), para poder revocar una sin detener las demás. Un proyecto tiene como máximo 20 llaves sin revocar.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Encabezados
-
Idempotency-Keystring, hasta 255 caracteres opcionalUn valor tuyo, de 1 a 255 caracteres, que hace que la llamada se pueda repetir sin riesgo. Mira idempotencia.
Cuerpo
-
namestring, hasta 80 caracteres obligatorioPara qué es la llave.
-
rate_limit_per_minuteinteger, 10 a 6,000 opcionalPeticiones por minuto que se aceptan desde una misma dirección con esta llave. Súbelo para un servidor que envía por muchas personas desde una sola dirección.
Por defecto:
600
Petición
curl -X POST "https://api.sypnia.com/v1/keys" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Checkout API"}'Respuesta201
{
"id": "key_8b5n2m7v4c1x",
"key": "spk_a3c9e1f7b5d2084c6e0a9f3b7d1c5e82",
"name": "Checkout API",
"rate_limit_per_minute": 600,
"created_at": "2026-03-12T10:40:00Z",
"last_used_at": null,
"revoked_at": null
}Errores
- 409
limit_reachedEl proyecto ya tiene 20 llaves sin revocar.
Revocar una llave de ingesta
/v1/keys/{key_id} MotorNube Revoca la llave. La ingesta con ella responde 401 en menos de un minuto. El registro se queda en la lista con revoked_at. Revocar no se puede deshacer; crea una llave nueva.
Parámetros de ruta
-
key_idstring obligatorioEl id del registro de la llave (
key_…), no la llave misma.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Petición
curl -X DELETE "https://api.sypnia.com/v1/keys/key_8b5n2m7v4c1x" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"Errores
- 404
not_foundNinguna llave del proyecto tiene este id.
- 409
conflictEs la última llave sin revocar del proyecto. Crea otra primero, para que tu app nunca se quede sin una.
Listar tokens de API
/v1/tokens MotorNube Los tokens de API del proyecto, incluidos los revocados y los vencidos. El secreto nunca se vuelve a mostrar; prefix son sus primeros 12 caracteres, suficientes para reconocerlo.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Petición
curl "https://api.sypnia.com/v1/tokens" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"Respuesta200
{
"data": [
{
"id": "tok_9r4t6y2u8i1o",
"name": "Cursor",
"prefix": "sps_4Kq9Zt2M",
"scopes": [
"read",
"replay"
],
"created_at": "2026-02-02T09:18:00Z",
"last_used_at": "2026-03-12T10:34:10Z",
"expires_at": null,
"revoked_at": null
}
],
"next_cursor": null
}Crear un token de API
/v1/tokens MotorNube Crea un token de API para el proyecto. El secreto está en token y se muestra solo en esta respuesta: el motor guarda un hash. Dale a un token los mínimos permisos que alcancen para el trabajo:
| Permiso | Qué permite |
|---|---|
read | Leer todo salvo el contenido de las grabaciones. Sus únicas escrituras son marcas reversibles: resolver o reabrir un problema, marcar una alerta como vista, cambiar el estado de una sugerencia |
replay | Traer grabaciones y capturas de página. Muestran la página como la vio la persona |
admin | Todo lo que cambia el proyecto: llaves, tokens, ajustes, versiones y source maps, comprobaciones de disponibilidad, reglas de alerta, webhooks, ignorar un problema, borrar datos |
Los permisos no se incluyen unos a otros: un token que deba leer y administrar necesita read y admin.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Encabezados
-
Idempotency-Keystring, hasta 255 caracteres opcionalUn valor tuyo, de 1 a 255 caracteres, que hace que la llamada se pueda repetir sin riesgo. Mira idempotencia.
Cuerpo
-
namestring, hasta 80 caracteres obligatorioQuién o qué lo va a usar. Aparece en
resolved_byy en el registro de cambios. -
scopeslista de string obligatorioQué puede hacer el token. Uno de:
read,replay,admin. -
expires_attimestamp opcionalCuándo deja de funcionar el token. Omítelo para un token que no vence.
Petición
curl -X POST "https://api.sypnia.com/v1/tokens" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Cursor", "scopes": ["read", "replay"]}'Respuesta201
{
"id": "tok_9r4t6y2u8i1o",
"name": "Cursor",
"prefix": "sps_4Kq9Zt2M",
"token": "sps_4Kq9Zt2MxV7bN1cR5wY8pL3dF6hJ0sA2gE4uT9iO",
"scopes": [
"read",
"replay"
],
"created_at": "2026-02-02T09:18:00Z",
"last_used_at": null,
"expires_at": null,
"revoked_at": null
}Errores
- 400
invalid_requestscopesestá vacío o tiene un valor distinto deread,replay,admin; oexpires_atestá en el pasado. - 409
limit_reachedEl proyecto ya tiene 50 tokens sin revocar.
Revocar un token de API
/v1/tokens/{token_id} MotorNube Revoca el token. Las peticiones con él responden 401 en menos de un minuto. Un token se puede revocar a sí mismo.
Parámetros de ruta
-
token_idstring obligatorioEl id del registro del token (
tok_…), no el secreto.
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403.
Petición
curl -X DELETE "https://api.sypnia.com/v1/tokens/tok_9r4t6y2u8i1o" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"Errores
- 404
not_foundNingún token del proyecto tiene este id.
Traer el uso y los límites
/v1/usage MotorNube Lo que el proyecto usó en el periodo actual y cuáles son sus límites. Un límite null significa sin límite: así son todos en un motor alojado por ti, salvo que definas una cuota en su configuración. En Sypnia Cloud los límites son los del plan y el periodo es el mes calendario, en UTC. Los límites de un plan son de la organización y los comparten sus proyectos: used es la parte de este proyecto, organization_used es lo que usaron todos sus proyectos juntos, y el límite se alcanza cuando organization_used llega a limit.
Los contadores son exactos y se actualizan a medida que llegan los datos. dropped_over_limit es cuántos eventos o grabaciones se rechazaron por haber llegado a un límite: Sypnia nunca descarta en silencio, lo cuenta aquí y le dice al SDK que baje el ritmo.
| Contador | Qué cuenta como uno |
|---|---|
events | Un error, una traza (una petición con sus spans) o una muestra de rendimiento (una vista de página con sus métricas). Los clics, los eventos propios y los trozos de grabación no cuentan |
replays | Una sesión que tiene grabación |
analyses | Una corrida del agente sobre un problema. Se cuenta por día |
pull_requests | Un pull request abierto por Sypnia. Solo en Sypnia Cloud |
Parámetros de consulta
-
projectstring opcionalEl id o el slug del proyecto. Solo hace falta con una credencial que ve varios proyectos (el token raíz). Con un token de API se ignora, salvo que nombre otro proyecto, que es
403. -
periodstring opcionalUn mes como
YYYY-MM, para leer un periodo pasado. Hasta 12 meses atrás.
Petición
curl "https://api.sypnia.com/v1/usage" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"Respuesta200
{
"project": {
"id": "prj_5k2m9x4q7w1z",
"slug": "shop",
"name": "Shop"
},
"plan": "builder",
"period": {
"start": "2026-03-01T00:00:00Z",
"end": "2026-04-01T00:00:00Z"
},
"events": {
"used": 18240,
"organization_used": 21902,
"limit": 50000,
"dropped_over_limit": 0
},
"replays": {
"used": 212,
"organization_used": 240,
"limit": 500,
"dropped_over_limit": 0
},
"analyses": {
"used_today": 4,
"limit_per_day": 100,
"used_this_period": 37
},
"pull_requests": {
"used": 6,
"organization_used": 6,
"limit": 50,
"dropped_over_limit": 0
},
"uptime_checks": {
"used": 1,
"limit": 5
},
"retention_days": {
"events": 30,
"replays": 30
},
"slow_down": null,
"daily": [
{
"day": "2026-03-11",
"events": 1610,
"replays": 19,
"analyses": 2
},
{
"day": "2026-03-12",
"events": 702,
"replays": 9,
"analyses": 4
}
]
}Los errores que cualquier endpoint puede responder (401, 403, 429, 500, 503) están en Errores, límites, paginación.