Explorar la referencia
Documentación para desarrolladores
La API de vokse
Todo en vokse está a una llamada de API. La aplicación web, los clientes externos y nuestra IA comparten la misma superficie REST, y tú también puedes usarla. Autentícate con una clave Bearer, limita sus permisos exactamente a lo que necesitas e intégrala en minutos.
Autenticación
Cada petición lleva un token Bearer en la cabecera Authorization. Genera una clave de API en Ajustes → Claves de API, elige sus scopes y listo.
URL base
https://api.vokse.aiUna primera petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ https://api.vokse.ai/households/current/accountsRecursos
188 endpoints repartidos en 28 recursos. Elige un recurso para ver cada operación, su scope, sus parámetros y un ejemplo listo para copiar y pegar.
Cuentas14 endpoints
Asistente de IA12 endpoints
- GETList pending AI actions awaiting user confirmation. Paginated with opaque cursor.
- POSTCancel a pending destructive action.
- POSTConfirm and execute a pending assistant action.
- POSTStream a chat turn (SSE). Returns text/event-stream. 403 AI_CONSENT_REQUIRED until the ai_processing consent is granted.
- +8
Análisis de IA2 endpoints
Conexiones bancarias15 endpoints
- GETList bank accounts in the household
- PATCHPause / resume sync for one bank account
- DELETEUnlink a bank account from its vokse account (the account and imported transactions stay; new movements stop arriving until mapped again)
- POSTMap a bank account to an existing financial_account or create a new one
- +11
Presupuestos9 endpoints
Categorías7 endpoints
Grupos de categorías4 endpoints
Divisas2 endpoints
Tipos de cambio2 endpoints
Previsiones1 endpoint
Objetivos4 endpoints
Historial (deshacer / rehacer)3 endpoints
- GETChange history, newest first: every recorded change with its performer; filter by member, family, kind, time window, group or explicit ids
- POSTRedo an undone change: reverts its active reversal so the change is in force again (409 HISTORY_NOT_UNDONE when it is not undone, HISTORY_STALE when the data moved on)
- POSTUndo a recorded change: applies its exact inverse, writes the reversal to the history and marks the change undone (409 HISTORY_STALE when the data moved on, HISTORY_ALREADY_UNDONE when another client got there first)
Miembros1 endpoint
Notificaciones6 endpoints
Beneficiarios13 endpoints
Tickets (OCR)16 endpoints
- GETLine items read from receipts, newest purchase first; unit prices are also given per base unit (kg, l, unit).
- GETUnit price of a product over time (per base unit, quantity-weighted per bucket) with the merchants it was bought at.
- GETPer-product summary across receipts: purchases, total spend, quantity-weighted average / min / max / latest unit price over the base unit, where it was bought.
- GETList receipts in this household; filter by link state, extraction status, kind, day, amount, merchant, tags or free text; sort by date, amount or merchant.
- +12
Recurrencias13 endpoints
Informes9 endpoints
- GETPlan vs reality: per-month assigned vs spent totals, adherence share of budgeted categories, and the biggest overruns of the range. Max 5-year range.
- GETPer-month income vs expense vs net (in base currency) over the range. Optional accountIds CSV (only these accounts). Max 5-year range.
- GETMonth-over-month spend per category (dense, zero-filled series in base currency). Optional accountIds CSV (only these accounts) and categoryIds CSV filters. Max 5-year range.
- GETIncome by source over the range (ADR 0107): unlabelled inflows plus every income category, month by month in the base currency. Optional accountIds CSV. Max 5-year range.
- +5
Reglas8 endpoints
Búsqueda1 endpoint
Etiquetas4 endpoints
Marcas de movimientos2 endpoints
Movimientos20 endpoints
Importación de movimientos1 endpoint
Usuarios3 endpoints
Voz6 endpoints
Guías
Tutoriales que escribimos a mano para los temas transversales: autenticación, errores, paginación, idempotencia y webhooks.
AutenticaciónLa API de vokse autentica cada petición con una clave de API Bearer. Las claves están acotadas, se pueden revocar y nunca caducan en silencio: mantienes el control de exactamente lo que una integración puede tocar.HogaresUn hogar es la unidad de aislamiento: cuentas, transacciones, presupuestos, categorías, reglas y claves pertenecen exactamente a uno. Tu clave también pertenece a uno; aquí tienes lo que eso te permite y lo que no.ErroresCada error de la API de vokse devuelve siempre el mismo envoltorio JSON con un código estable legible por máquina, un mensaje para humanos y, opcionalmente, detalles estructurados. Programa según el código y muestra el mensaje.PaginaciónLos endpoints de listado paginan con un cursor opaco. Nunca calculas desplazamientos: sigues nextCursor hasta que sea null. Los cursores son estables ante escrituras concurrentes, así que nunca te saltas ni lees dos veces una fila.IdempotenciaLas peticiones que modifican estado se pueden reintentar sin riesgo si envías una Idempotency-Key. Si una petición se pierde por un timeout, repetirla con la misma clave devuelve el resultado original en lugar de crear un duplicado.Límites de peticionesCada petición se cuenta dentro de una ventana fija de 60 segundos. El contador que se aplica depende de cómo te autenticas: las claves de API disponen del mayor presupuesto, las sesiones iniciadas de uno holgado y el tráfico anónimo de uno pequeño. Agotado el presupuesto, la API responde 429 y te indica cuánto esperar.Recibir webhooksLos webhooks te envían eventos en tiempo real en lugar de tener que hacer polling. Suscribe una URL, elige los eventos que te interesan y verifica cada entrega con su firma HMAC.Historial, deshacer y rehacer en la APIvokse mantiene un libro de cambios por hogar: una fila por cambio atómico con la carga exacta para revertirlo, quién lo hizo y cuándo. La API expone las filas que produce una escritura, lista el historial con sus autores y revierte cualquier cambio registrado, con precisión y desde cualquier cliente.MCPvokse incluye un servidor MCP remoto: las mismas herramientas auditadas que llaman el asistente y la aplicación, expuestas a través del Model Context Protocol. Una URL y OAuth estándar; sin binarios ni claves de API.
OpenAPI en crudo
¿Prefieres un explorador interactivo? El documento OpenAPI completo se sirve en directo, renderizado con Scalar.
Abrir la referencia OpenAPI