Skip to main content
The Lumenfall API is OpenAI-compatible, meaning you can use existing OpenAI SDKs by simply changing the base URL to https://api.lumenfall.ai/openai/v1.

Base URL

https://api.lumenfall.ai/openai/v1

Authentication

All API requests require a Bearer token in the Authorization header:
Authorization: Bearer lmnfl_your_api_key
Get your API key from the Lumenfall dashboard.

Request format

All requests should include:
  • Content-Type: application/json header
  • JSON request body (for POST requests)

Response format

All responses follow the OpenAI response format. Successful responses return JSON with the requested data. Error responses include an error object:
{
  "error": {
    "message": "Invalid API key",
    "type": "authentication_error",
    "code": "AUTHENTICATION_FAILED"
  }
}

Error codes

CodeHTTP StatusDescription
AUTHENTICATION_FAILED401Invalid or missing API key
INSUFFICIENT_BALANCE402Account balance too low (prepaid accounts)
INVALID_REQUEST400Malformed request or invalid parameters
MODEL_NOT_FOUND404Requested model does not exist
MODEL_DISABLED404Model is currently disabled
RATE_LIMITED429Too many requests
ALL_PROVIDERS_EXHAUSTED502All providers failed to handle the request
UPSTREAM_ERRORvariesA provider returned an error

Rate limits

Lumenfall does not impose strict per-request rate limits. Your usage is governed by your account balance - requests are processed as long as you have sufficient credits. For prepaid accounts, ensure you have enough balance or enable auto top-up to avoid interruptions.

Dry run mode

Add ?dryRun=true to any request to get a cost estimate without executing it. See Cost estimation for details and response format.