Quick start
Create an API key in Settings > API, then make your first request:
bash
curl -H "Authorization: Bearer sk_live_your_key" \
http://localhost:4173/api/v1/analysesAuthentication
Authenticate requests with an API key. Create keys in your Settings > API tab. API access requires a Pro or Agency plan.
Three ways to send your key:
bash
# Authorization header (recommended)
curl -H "Authorization: Bearer sk_live_..." http://localhost:4173/api/v1/analysesbash
# X-API-Key header
curl -H "X-API-Key: sk_live_..." http://localhost:4173/api/v1/analysesbash
# Query parameter (SSE endpoints only)
curl "http://localhost:4173/api/v1/analyses/:id/stream?api_key=sk_live_..."API keys start with
sk_live_ followed by 32 hex characters. The full key is only shown once at creation — store it securely.Rate Limiting
All responses include standard rate limit headers:
| Parameter | Type |
|---|---|
RateLimit-Limit | integer |
RateLimit-Remaining | integer |
RateLimit-Reset | integer |
| Plan | Rate Limit | Price |
|---|---|---|
| Starter | No API access | $49/mo |
| Pro | 60 req/min | $99/mo |
| Agency | 120 req/min | $199/mo |
Errors
Errors return JSON with an error field:
Response
{ "error": "Authentication required" }| Code | Meaning |
|---|---|
400 | Invalid request body or parameters |
401 | Missing or invalid authentication |
402 | Plan limit exceeded or insufficient credits |
403 | Feature not available on your plan |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Internal server error |
503 | Maintenance mode |
Analyses
Analyze competitor websites. The API scrapes the site, runs AI content analysis, identifies gaps, and generates an action plan.
Generate AI-written articles from gap analysis findings. Uses a 5-pass pipeline: research, outline, draft, humanize, and fact-check.