API Overview
SDD Classification: L3-Technical
Authority: Engineering Team
Review Cycle: Quarterly
API Architecture
Key API Features
Base URLs
Production Environment
Development Environment
Authentication Overview
Materi uses JWT (JSON Web Tokens) for secure, stateless authentication across all API endpoints.Token Types
Authentication Methods
Method A: User Authentication (OAuth 2.0) For applications acting on behalf of users with delegated authorization.Using Access Tokens
Include the token in the Authorization header for all API requests:Rate Limiting
Rate Limits by Plan
Rate Limit Headers
Every API response includes rate limit information:Handling Rate Limits
Error Handling
Standard Error Response Format
All API errors follow a consistent format:HTTP Status Codes
Error Codes Reference
Authentication Errors:INVALID_TOKEN- JWT token is malformed or expiredINSUFFICIENT_PERMISSIONS- User lacks required permissionsACCOUNT_SUSPENDED- User account is temporarily disabled
DOCUMENT_NOT_FOUND- Document ID doesn’t exist or no accessWORKSPACE_NOT_FOUND- Workspace doesn’t exist or no accessUSER_NOT_FOUND- User ID doesn’t exist in workspace
INVALID_DOCUMENT_CONTENT- Document content format is invalidTITLE_TOO_LONG- Document title exceeds maximum lengthINVALID_EMAIL_FORMAT- Email address format is incorrect
DOCUMENT_LOCKED- Document is locked by another operationVERSION_CONFLICT- Document version has changed during editDUPLICATE_RESOURCE- Resource with same identifier already exists
Quick Start Example
SDKs and Libraries
Official SDKs
JavaScript/TypeScriptAPI Endpoints Summary
Documents
AI Operations
Collaboration
Authentication
Health & Monitoring
Related Documentation
- Authentication - Detailed authentication guide
- Rate Limits - Rate limiting policies
- Errors - Complete error reference
- WebSocket API - Real-time collaboration
Document Status: Complete Version: 2.0