Developers
REST API (v1)
The EliteVault API lets you run store audits programmatically. It is available on the Scale plan ($49/mo). All requests use HTTPS and return JSON.
Authentication
Authenticate with a bearer token. Create and manage tokens in Settings → API keys. Pass it in the Authorization header:
Authorization: Bearer ev_live_xxxxxxxxxxxxxxxxKeep tokens secret — they grant full API access to your account. Never expose them in client-side code.
Usage limits
API audits draw from your plan's monthly analysis allowance (Scale: 200 audits / month). When you run out, requests return 402 out_of_credits until your next billing period.
Create an analysis
POST /api/v1/analyses — queues an audit and returns immediately. Body:
url(string, required) — the store URL to audit.persona(object, optional) — a buyer persona to simulate against.run_rewrite(boolean, optional, default true) — also generate a rewrite of the hero section.
curl https://elitevaultapp.com/api/v1/analyses \
-H "Authorization: Bearer ev_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "url": "https://yourstore.com" }'Returns 202 Accepted:
{
"id": "8f3c…",
"status": "queued",
"check_at": "/api/v1/analyses/8f3c…"
}Retrieve an analysis
GET /api/v1/analyses/{id} — poll check_at until status is succeeded (or failed/refunded). Statuses: queued, running, succeeded, failed, refunded.
{
"id": "8f3c…",
"status": "succeeded",
"url": "https://yourstore.com",
"screenshot_url": "https://…",
"result": {
"score": 62,
"summary": "…",
"category_scores": { "color": 70, "layout": 55, "imagery": 64,
"technical": 60, "niche_coherence": 58, "cro_principles": 65 },
"top_fixes": [ { "title": "Move primary CTA above the fold", … } ],
"annotations": [ … ],
"buyer_persona_response": { … },
"scenarios": { … }
},
"meta_ads": { … },
"created_at": "…", "finished_at": "…"
}The overall score is 0–100. Fields populate only once status is succeeded. Scores are AI-generated estimates, not guarantees.
Errors
Errors return a JSON body with an error code:
401 missing_bearer_token— no/invalid token.403 scale_plan_required— your plan doesn't include API access.402 out_of_credits— monthly allowance exhausted.400 invalid_body— request body failed validation.404 not_found— analysis id not found, or not yours.
Need help?
Manage your keys in Settings → API keys, or contact support.