Introduction to ozzie-openapi
ozzie-openapi is a stateless intelligence API for financial coaching. It accepts financial context as request input and returns plans, envelope allocations, personality scores, chat responses, transaction parses, and money move recommendations.
Base URL: https://api.ozzieapp.com/v1
What it does
| Capability | How to invoke |
|---|---|
| Create and retrieve users | POST /v1/users, GET /v1/users/:id |
| Collect financial intake | POST /v1/users/:id/financial-intake |
| Score a personality quiz | GET /v1/personality/questions, POST /v1/personality/score |
| Generate a financial plan | POST /v1/users/:id/plan/generate |
| Get envelope allocations | GET /v1/users/:id/financial-profile |
| Stateless AI chat | POST /v1/users/:id/chat/completion |
| Parse transactions from text, image, PDF | POST /v1/transactions/parse |
| Generate weekly money moves | POST /v1/money-moves/generate |
Design principles
Stateless intelligence. Every request must include the context needed to produce the response. The API does not maintain conversation history, session state, or runtime personalization state. The caller is responsible for passing personality_type, conversation history, and any other context on each call.
Caller-owned state. personality_type is always passed as a query parameter or request body field — it is never inferred or stored implicitly. You decide when to score personality and how to store the result.
Context in, intelligence out. Endpoints return computed outputs — plans, allocations, scored types, parsed transactions, move recommendations — without side effects.
Key concepts
| Concept | Description |
|---|---|
| Users | A user identity record with an external_user_id you supply |
| Financial Intake | A monthly snapshot of income, expenses, and goal — the foundation for plan generation |
| Personality | One of four types (HOTSHOT, STOCKPILER, GIVER, INDEPENDENT) scored from a quiz — shapes envelope weights and AI tone |
| Envelopes | Six budget buckets that divide a user's income according to personality type |
| Plan | A generated financial plan with tier, envelope allocations, and personalized action items |
| Money Moves | Weekly recommended tasks — a do action, a learn task, and a mind task — personalized by personality type and plan tier |
| Transactions | AI-parsed individual spending records mapped to envelopes |
| Chat Completion | Stateless AI inference — you provide message, history, and personality; the API returns a reply |
Authentication
HTTP Bearer with a base64-encoded client_id:client_secret token.
Authorization: Bearer base64(client_id:client_secret)
Quick links
- Authentication — get credentials and sign requests
- Quickstart — create a user, run onboarding, and call the AI coach
- API Flow — complete step-by-step sequence
- Personality Types — the four types, quiz flow, and how personality shapes the plan
- Envelope System — the six budget buckets and personality weight tables
- API Overview — full endpoint table