Flarelight Documentation

API Reference

Complete API documentation for all Flarelight endpoints and methods.

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.flarelight.com/v1

Endpoints

GET/projects

Retrieve a list of all projects.

Response

{
  "data": [
    {
      "id": "proj_123",
      "name": "My Project",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 1
}
POST/projects

Create a new project.

Request Body

{
  "name": "My New Project",
  "description": "Project description"
}

Response

{
  "data": {
    "id": "proj_456",
    "name": "My New Project",
    "description": "Project description",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Error Handling

All errors follow a consistent format:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request was invalid",
    "details": "Additional error details"
  }
}

⚠️ Rate Limiting

API requests are rate limited to 1000 requests per hour per API key. Rate limit headers are included in all responses.