ReferenceAPI
API Reference
Complete API reference for GoodMem - gRPC and REST protocols
GoodMem API Reference
GoodMem provides two equivalent API protocols for accessing vector-based memory storage and retrieval services.
Version: Based on GoodMem improve-proto-documentation
Choose Your Protocol
🚀 gRPC API
High-performance binary protocol with type safety and streaming support.
Best for: Backend services, microservices, high throughput
View gRPC Reference →
🌐 REST API
Standard HTTP/JSON API with broad tooling support and browser compatibility.
Best for: Web apps, integrations, testing
View REST Reference →
Quick Start
- Get an Overview - Compare protocols and choose what's right for you
- Create an API Key - Use the gRPC CreateApiKey method
- Start Building - Browse the complete API documentation for your chosen protocol
What's the Same
Both protocols provide identical functionality:
- Same operations - All methods available in both protocols
- Same data - Identical request/response structures
- Same authentication - API key-based authentication
- Same rate limits - Shared quotas and throttling
What's Different
The protocols differ in wire format and tooling:
- gRPC uses binary Protocol Buffers for efficiency
- REST uses JSON over HTTP for simplicity and compatibility
Need help choosing? Check out the detailed comparison.