In der Referenz stöbern
Entwicklerdokumentation
Die vokse-API
Alles in vokse ist nur einen API-Aufruf entfernt. Die Web-App, externe Clients und unsere KI sprechen dieselbe REST-Schnittstelle, und du kannst das auch. Authentifiziere dich mit einem Bearer-Schlüssel, gib ihm genau die Rechte, die du brauchst, und in wenigen Minuten läuft deine Integration.
Authentifizierung
Jede Anfrage trägt ein Bearer-Token im Authorization-Header. Erzeuge unter Einstellungen → API-Schlüssel einen Schlüssel, wähle seine Scopes, und schon kann es losgehen.
Basis-URL
https://api.vokse.aiEine erste Anfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ https://api.vokse.ai/households/current/accountsRessourcen
188 Endpunkte in 28 Ressourcen. Wähle eine Ressource, um jede Operation zu sehen: Scope, Parameter und ein Beispiel zum Kopieren.
Konten14 Endpunkte
KI-Assistent12 Endpunkte
- 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
KI-Einblicke2 Endpunkte
Bankverbindungen15 Endpunkte
- 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 Endpunkte
Kategorien7 Endpunkte
Kategoriegruppen4 Endpunkte
Währungen2 Endpunkte
Wechselkurse2 Endpunkte
Prognosen1 Endpunkt
Ziele4 Endpunkte
Verlauf (Rückgängig / Wiederholen)3 Endpunkte
- 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)
Benachrichtigungen6 Endpunkte
Zahlungsempfänger13 Endpunkte
Belege (OCR)16 Endpunkte
- 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
Wiederkehrende Buchungen13 Endpunkte
Berichte9 Endpunkte
- 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
Regeln8 Endpunkte
Suche1 Endpunkt
Tags4 Endpunkte
Buchungsmarkierungen2 Endpunkte
Buchungen20 Endpunkte
Benutzer3 Endpunkte
Sprache6 Endpunkte
Leitfäden
Von Hand geschriebene Anleitungen zu den übergreifenden Themen: Authentifizierung, Fehler, Paginierung, Idempotenz und Webhooks.
AuthentifizierungDie vokse-API authentifiziert jede Anfrage mit einem Bearer-API-Schlüssel. Schlüssel haben feste Scopes, lassen sich widerrufen und laufen nie stillschweigend ab. Du behältst die volle Kontrolle darüber, worauf eine Integration zugreifen darf.HaushalteEin Haushalt ist die Mandanteneinheit: Konten, Transaktionen, Budgets, Kategorien, Regeln und Schlüssel gehören zu genau einem. Dein Schlüssel auch, hier steht, was das erlaubt und was nicht.FehlerJeder Fehler der vokse-API kommt im selben JSON-Format: ein stabiler, maschinenlesbarer Code, eine für Menschen verständliche Nachricht und optionale strukturierte Details. Entwickle gegen den Code, zeige die Nachricht an.PaginierungList-Endpunkte blättern mit einem opaken Cursor. Offsets rechnest du nie aus, du folgst einfach nextCursor, bis er null ist. Cursor bleiben auch bei gleichzeitigen Schreibvorgängen stabil, du überspringst also keine Zeile und liest keine doppelt.IdempotenzVerändernde Anfragen lassen sich durch Senden eines Idempotency-Key gefahrlos wiederholbar machen. Geht eine Anfrage durch ein Timeout verloren, liefert ihre Wiederholung mit demselben Schlüssel das ursprüngliche Ergebnis zurück, statt ein Duplikat zu erzeugen.Rate LimitsJede Anfrage zählt gegen ein festes 60-Sekunden-Fenster. Welcher Zähler gilt, hängt davon ab, wie du dich authentifizierst: API-Schlüssel bekommen das größte Budget, angemeldete Sitzungen ein großzügiges, anonymer Verkehr ein kleines. Ist das Budget aufgebraucht, antwortet die API mit 429 und sagt dir, wie lange du warten musst.Webhooks empfangenWebhooks schicken dir Ereignisse in Echtzeit, statt dass du sie abfragen musst. Trage eine URL ein, wähle die Ereignisse aus, die dich interessieren, und prüfe jede Zustellung anhand ihrer HMAC-Signatur.Verlauf, Rückgängig und Wiederholen in der APIvokse führt pro Haushalt ein Änderungsbuch: eine Zeile pro atomarer Änderung mit der exakten Nutzlast, um sie zurückzunehmen, wer sie wann gemacht hat. Die API legt die Zeilen eines Schreibvorgangs offen, listet den Verlauf mit Urhebern und nimmt jede aufgezeichnete Änderung präzise zurück, von jedem Client.MCPvokse bringt einen Remote-MCP-Server mit: dieselben auditierten Tools, die Assistent und App aufrufen, nur eben über das Model Context Protocol. Eine URL, Standard-OAuth, keine Binaries, keine API-Schlüssel.
OpenAPI im Rohformat
Lieber ein interaktiver Explorer? Das vollständige OpenAPI-Dokument wird live bereitgestellt, gerendert mit Scalar.
OpenAPI-Referenz öffnen