Skip to main content
The API is read-only for now. Version 1 reads data. Creating and updating records comes next, and the changelog will say when.
1

Create an API key

In Overjoy, go to Settings → Developers → API Keys and click Create key. Only brand admins can create keys. Copy the key when it appears, because you won’t see it again.
Terminal
2

Make your first call

Every call goes to https://api.overjoy.ai/v1 with your key in the Authorization header. GET /brand returns the brand the key belongs to, so it’s a good first test.
200 OK

Next steps

Connect your AI assistant

Ask questions about your accounts in plain English, through MCP.

Keys and scopes

Choose what each key can read.

Handle errors

Every error has a type, a message and a request ID.