FlickerFaith API

Integrate FlickerFaith's Christian AI assistant into your application.

Authentication

All requests require an API key passed via the X-API-Key header.

X-API-Key: ff_live_your_api_key_here

Contact FlickerFaith to obtain an API key. Each key has configurable rate limits.

Endpoint

POST /v1/chat

Request Body

FieldTypeRequiredDescription
messagestringYesThe user's message (max 10,000 chars)
conversationHistoryarrayNoPrevious messages: [{role: "user"|"assistant", content: "..."}] (max 20)
personastringNoAI persona: default, biblical_scholar, or simple_helper
maxTokensnumberNoMax response tokens (capped by your key's limit)

Example Request

curl -X POST https://us-central1-flickergpt.cloudfunctions.net/publicChat \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ff_live_your_key_here" \
  -d '{
    "message": "What does Philippians 4:13 mean?",
    "persona": "biblical_scholar"
  }'

Example Response

{
  "success": true,
  "data": {
    "message": "Philippians 4:13 — 'I can do all things through Christ...'",
    "model": "claude-sonnet-4-20250514",
    "usage": { "inputTokens": 180, "outputTokens": 350 }
  },
  "meta": {
    "requestId": "a1b2c3d4-...",
    "latencyMs": 2150,
    "persona": "biblical_scholar",
    "rateLimits": {
      "daily": { "limit": 100, "remaining": 87 },
      "monthly": { "limit": 2000, "remaining": 1543 }
    }
  }
}

Personas

IDDescription
defaultBalanced Christian AI assistant — bold, Biblical, compassionate
biblical_scholarAcademic depth — Hebrew/Greek origins, manuscript traditions, church history
simple_helperWarm encourager — short, practical, plain language for new believers

Error Codes

HTTPCodeDescription
401MISSING_API_KEYNo API key provided
401INVALID_API_KEYKey not found or revoked
429DAILY_LIMIT_EXCEEDEDDaily message cap reached (resets midnight UTC)
429MONTHLY_LIMIT_EXCEEDEDMonthly cap reached (resets 1st of month)
400INVALID_REQUESTMissing or invalid message field
400INVALID_PERSONAUnknown persona ID
500INTERNAL_ERRORServer error — retry the request

Rate Limits

Each API key has configurable daily and monthly message limits. Current limits are returned in every response under meta.rateLimits. When a limit is exceeded, the API returns HTTP 429.

Notes

© 2025 FlickerFaith · flickerfaith.com