Opey
The OBP AI assistant for exploring the API.
Opey — the OBP AI Assistant
Opey is an AI-powered assistant that helps you explore and understand the Open Bank Project API. You can ask Opey questions in natural language and it will help you find the right endpoints, explain concepts, and generate example requests.
What Can Opey Do?
- Find endpoints — ask "How do I list transactions?" and Opey will point you to the right API call
- Explain concepts — ask "What is a View in OBP?" for a clear explanation
- Generate examples — ask "Show me a curl command to get my accounts" for ready-to-use code
- Troubleshoot errors — paste an error code like OBP-10404 and Opey will explain what went wrong
- Navigate the API — ask about authentication, permissions, or any OBP topic
Where to Find Opey
Opey is available in the OBP Portal and the OBP API Manager. Look for the chat interface to start a conversation.
Tips for Getting the Best Results
- Be specific about what you want to achieve, e.g. "I want to create a transaction request for a SEPA payment"
- Include context like the bank_id or account_id you're working with
- Ask follow-up questions to drill deeper into a topic
- You can paste JSON responses or error messages for Opey to analyse
Example Conversations
Discovering endpoints:
"What endpoints do I need to create a counterparty and then make a payment to them?"
Understanding permissions:
"What entitlements does a user need to create accounts at a bank?"
Debugging:
"I'm getting OBP-20001 when I try to call /my/accounts. What does this mean?"
Opey and the API
Opey has access to the full OBP API specification, including all endpoints, request/response schemas, glossary terms, and error codes. It stays up to date with the API so you always get accurate information.
Related
- What Opey Can Do — consents, entitlements and what Opey may do on your behalf
- Agents and MCP — connect your own AI agents to the OBP API
- API Explorer — browse and test endpoints