Skip to main content

ā€‹
Base URL

  • Local: http://localhost:8000
  • Production: https://api.yourdomain.com (or your deployed API URL)

ā€‹
Authentication

ā€‹
Dashboard API (Bearer token)

For dashboard endpoints (brands, queries, mentions, etc.): 
Authorization: Bearer <your_jwt_token>
Obtain the token by logging in via POST /api/auth/login or registering via POST /api/auth/register.

ā€‹
Customer API (API key)

For the Customer Reports API (used by integrations): 
X-API-Key: <your_api_key>
Create API keys in Dashboard > API Keys (Custom plan only).

ā€‹
Response Format

All endpoints return JSON. Errors include an error and optional message: 
{
  "error": "Query limit reached",
  "message": "Your Free plan allows up to 2 prompts per month. Upgrade to run more.",
  "currentUsage": 2,
  "limit": 2,
  "plan": "FREE"
}

ā€‹
Rate Limits

API rate limits may apply in production. 429 responses indicate rate limiting.

ā€‹
OpenAPI Spec

For full endpoint documentation, import the OpenAPI spec from your deployment:
  • backend/openapi.json ā€” Copy to your API base URL + /openapi.json when deployed