Skip to main content

​
Overview

The Softmaple API provides programmatic access to manage documents, workspaces, and collaboration features. This reference documentation covers all available endpoints and their usage.

​
Base URL

All API endpoints are relative to:
For local development:

​
Authentication

Most API endpoints require authentication using Supabase Auth. Include the session token in the Authorization header:

​
Available Endpoints

Document Endpoints

Manage documents and their content

Workspace Endpoints

Create and manage workspaces

​
Rate Limiting

API requests are limited to:
  • 100 requests per minute for authenticated users
  • 20 requests per minute for unauthenticated users

​
Response Format

All API responses are in JSON format:

​
Error Handling

Errors are returned with appropriate HTTP status codes:
  • 400 Bad Request - Invalid parameters
  • 401 Unauthorized - Missing or invalid authentication
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Resource doesn’t exist
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server-side error