Skip to main content

API Overview

SDD Classification: L3-Technical Authority: Engineering Team Review Cycle: Quarterly
Materi provides comprehensive REST and WebSocket APIs that enable you to integrate document collaboration, AI generation, and real-time editing into your applications. Build custom workflows, automate content creation, and embed Materi’s capabilities directly into your products.

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.
Method B: Service Authentication (Client Credentials) For server-to-server integrations without user context.

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 expired
  • INSUFFICIENT_PERMISSIONS - User lacks required permissions
  • ACCOUNT_SUSPENDED - User account is temporarily disabled
Resource Errors:
  • DOCUMENT_NOT_FOUND - Document ID doesn’t exist or no access
  • WORKSPACE_NOT_FOUND - Workspace doesn’t exist or no access
  • USER_NOT_FOUND - User ID doesn’t exist in workspace
Validation Errors:
  • INVALID_DOCUMENT_CONTENT - Document content format is invalid
  • TITLE_TOO_LONG - Document title exceeds maximum length
  • INVALID_EMAIL_FORMAT - Email address format is incorrect
Conflict Errors:
  • DOCUMENT_LOCKED - Document is locked by another operation
  • VERSION_CONFLICT - Document version has changed during edit
  • DUPLICATE_RESOURCE - Resource with same identifier already exists

Quick Start Example


SDKs and Libraries

Official SDKs

JavaScript/TypeScript
Python
Go

API Endpoints Summary

Documents

AI Operations

Collaboration

Authentication

Health & Monitoring



Document Status: Complete Version: 2.0