oomfy · documentation

Build on oomfy.

oomfy is an 18+ AI character and companion platform — characters that remember, with visible, editable memory. This is the home for the platform and the HTTP API.

The apps

chat.oomfyapp.com →

The AI experience — discover characters, chat, scenes, groups, memory.

creator.oomfyapp.com →

The Character Studio — create, edit, and manage your characters.

oomfyapp.com →

Marketing, character pages, and the mobile app.

status.oomfyapp.com →

Live status of every oomfy service.

API

The REST API is served under a versioned prefix. All responses are JSON.

Base: https://api.oomfyapp.com/v1 Auth: Bearer <access token>
curl https://api.oomfyapp.com/v1/health
# → { "status": "ok" }

Authenticate with email + password or Google, then send the access token as Authorization: Bearer <token>. Errors are a stable { error: { code, message, details? } } shape.

POST/v1/auth/register · /v1/auth/login — email + password → access + refresh tokens.
POST/v1/auth/oauth/google — exchange a Google id_token for a session.
GET/v1/me — the current user, entitlements, and Sparks balance.
GET/v1/discovery/rails — the discovery shelves.
GET/v1/characters/:slug — a character, with greeting, tags, rating.
POST/v1/chats then /v1/chats/:id/messages (SSE) — start a chat and stream a reply.
GET/v1/billing/plans — the plan catalogue for the caller's region.

Legal & safety

Terms · Privacy · Crisis resources · Support

Every AI-generated surface is labelled as such — permanently, per CA SB 243 and the EU AI Act.

© oomfy · 18+ · The characters remember.