API DOCUMENTATION ============================== API: [API NAME] Version: v[X.X] Base URL: https://api.[domain].com/v[X] Auth: Bearer token / API key / OAuth 2.0 Updated: [DATE] AUTHENTICATION ------------------------------ Authorization: Bearer YOUR_API_KEY Get your key at: [URL] ENDPOINTS ------------------------------ GET /[resource] Description: [What this returns] Parameters: Name | Type | Required | Description --------|---------|----------|------------- [param] | string | Yes | [Description] [param] | integer | No | [Description, default: X] Example Request: GET /[resource]?param=value Authorization: Bearer YOUR_API_KEY Example Response (200 OK): { "status": "success", "data": { "[field]": "[value]" }, "meta": { "total": 100, "page": 1 } } ------------------------------ POST /[resource] Description: [What this creates] Request Body (application/json): { "[field]": "string (required)", "[field]": "integer (optional)" } Response (201 Created): { "status": "success", "data": { "id": "[id]" } } ERROR CODES ------------------------------ 400 Bad Request | Missing or invalid parameters 401 Unauthorized | Invalid API key 403 Forbidden | Insufficient permissions 404 Not Found | Resource does not exist 429 Rate Limited | Slow down requests 500 Server Error | Contact support RATE LIMITS ------------------------------ Free: [X] req/min Pro: [X] req/min Headers: X-RateLimit-Limit | X-RateLimit-Remaining | X-RateLimit-Reset