Parcourir la référence
Documentation développeur
L'API vokse
Dans vokse, tout n'est qu'à un appel d'API. L'application web, les clients externes et notre IA s'appuient tous sur la même surface REST, et vous pouvez en faire autant. Authentifiez-vous avec une clé Bearer, limitez-la précisément à ce dont vous avez besoin, et intégrez en quelques minutes.
Authentification
Chaque requête transporte un jeton Bearer dans l'en-tête Authorization. Générez une clé API dans Paramètres → Clés API, choisissez ses scopes, et c'est prêt.
URL de base
https://api.vokse.aiUne première requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \ https://api.vokse.ai/households/current/accountsRessources
188 endpoints répartis sur 28 ressources. Choisissez une ressource pour voir chaque opération, son scope, ses paramètres et un exemple prêt à copier-coller.
Comptes14 endpoints
Assistant 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
Analyses IA2 endpoints
Connexions bancaires15 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
Budgets9 endpoints
Catégories7 endpoints
Groupes de catégories4 endpoints
Devises2 endpoints
Taux de change2 endpoints
Prévisions1 endpoint
Objectifs4 endpoints
Historique (annuler / rétablir)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)
Membres1 endpoint
Notifications6 endpoints
Bénéficiaires13 endpoints
Reçus (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
Récurrences13 endpoints
Rapports9 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
Règles8 endpoints
Recherche1 endpoint
Étiquettes4 endpoints
Marqueurs de transactions2 endpoints
Transactions20 endpoints
Utilisateurs3 endpoints
Voix6 endpoints
Guides
Des guides rédigés à la main pour les sujets transverses : authentification, erreurs, pagination, idempotence et webhooks.
AuthentificationL'API vokse authentifie chaque requête avec une clé API Bearer. Les clés sont restreintes par scope, révocables et n'expirent jamais en silence : vous gardez le contrôle total de ce qu'une intégration peut toucher.FoyersUn foyer est l'unité d'isolement : comptes, transactions, budgets, catégories, règles et clés appartiennent à un seul. Votre clé aussi : voici ce qu'elle permet, et ce qu'elle ne permet pas.ErreursChaque erreur de l'API vokse renvoie une enveloppe JSON cohérente, avec un code stable lisible par une machine, un message lisible par un humain et des détails structurés optionnels. Construisez votre logique autour du code, affichez le message.PaginationLes endpoints de liste paginent à l'aide d'un curseur opaque. Vous ne calculez jamais d'offsets : vous suivez nextCursor jusqu'à ce qu'il soit null. Les curseurs restent stables face aux écritures concurrentes, vous ne sautez donc jamais une ligne et n'en lisez jamais deux fois.IdempotenceUne requête qui modifie des données peut être réessayée sans risque si vous envoyez un Idempotency-Key. Si une requête est perdue à cause d'un timeout, la rejouer avec la même clé renvoie le résultat d'origine au lieu de créer un doublon.Limites de débitChaque requête est comptée dans une fenêtre fixe de 60 secondes. Le compteur appliqué dépend de votre mode d'authentification : les clés API disposent du budget le plus large, les sessions connectées d'un budget confortable, le trafic anonyme d'un petit budget. Une fois le budget épuisé, l'API répond 429 et vous indique combien de temps attendre.Recevoir des webhooksLes webhooks vous poussent les événements en temps réel, au lieu de vous obliger à interroger l'API. Déclarez une URL, choisissez les événements qui vous intéressent et vérifiez chaque livraison grâce à sa signature HMAC.Historique, annuler et rétablir dans l'APIvokse tient un registre des changements par foyer : une ligne par changement atomique avec la charge exacte pour l’inverser, son auteur et l’instant. L’API expose les lignes produites par une écriture, liste l’historique avec ses auteurs et inverse tout changement enregistré, précisément, depuis n’importe quel client.MCPvokse embarque un serveur MCP distant : les mêmes outils audités que ceux de l'assistant et de l'application, exposés via le Model Context Protocol. Une URL, OAuth standard, pas de binaires, pas de clés API.
OpenAPI brut
Vous préférez un explorateur interactif ? Le document OpenAPI complet est servi en direct, rendu avec Scalar.
Ouvrir la référence OpenAPI