API Reference¶
You can authenticate APIs using either OAuth2 or API keys. OAuth2 is a standard authorization framework that enables applications to securely access specific documents within a system. On the other hand, API keys provide a simpler method to retrieve documents from a common knowledge base without the need to undergo the OAuth2 authentication process.
API Overview¶
Rememberizer provides a comprehensive set of APIs for working with documents, vector stores, mementos, and more. The APIs are organized into the following categories:
Authentication APIs¶
- Sign Up, Sign In, Email Verification
- Password Reset
- OAuth Endpoints (Google, Microsoft)
- Token Management and Logout
User APIs¶
- User Profile and Account Information
- User Onboarding
Document APIs¶
- List, Create, and Update Documents
- Document Processing
- Batch Document Operations
Search APIs¶
- Basic Search
- Agentic Search
- Batch Search Operations
Mementos APIs¶
- Create, List, Update, and Delete Mementos
- Manage Memento Documents
Vector Stores APIs¶
- Create and List Vector Stores
- Upload Text and File Documents
- Search Vector Stores
- Batch Upload and Search
Integrations APIs¶
- List Integrations
- OAuth Integration Endpoints (Google Drive, Gmail, Slack, Dropbox)
Applications APIs¶
- List and Create Applications
Common Knowledge APIs¶
- List and Create Common Knowledge Items
Team APIs¶
- Team Management
- Team Members
- Role-Based Permissions
For enterprise integration patterns, security considerations, and architectural best practices, see the Enterprise Integration Patterns guide.
Base URL¶
All API endpoints are relative to:
Authentication¶
Endpoints require authentication using either:
- JWT token (passed in Authorization header or cookies)
- API key (passed in x-api-key header)
For detailed information about specific endpoints, refer to the individual API documentation pages.