API

Requires a Premium subscription

Submit sites for analysis and pull results from your own scripts. API submissions go through the same queue as the web app, so your API and dashboard usage share the same limits and run one at a time.

Authentication

Generate a token in your dashboard (Premium). Send it as a bearer token on every request. Rotating the token invalidates the old one — keep it secret.

Authorization: Bearer op_live_xxxxxxxxxxxxxxxx

Base URL

https://onepromptai.app/api/v1

Endpoints

POST/analyze

Queue a site for analysis. Returns immediately with a status; poll /status for the result.

curl -X POST https://onepromptai.app/api/v1/analyze \
  -H "Authorization: Bearer $ONEPROMPT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"linear.app"}'

# → { "url":"linear.app", "status":"processing",
#     "statusUrl":"/api/v1/status?url=linear.app" }

GET/status?url=<url>

The status of a site you submitted: queued, processing, completed (with the report), failed, or not_found.

curl "https://onepromptai.app/api/v1/status?url=linear.app" \
  -H "Authorization: Bearer $ONEPROMPT_TOKEN"

# → { "url":"linear.app", "status":"completed",
#     "reportId":"…", "report": { … } }

GET/reports

List the sites you've analyzed.

GET/reports/:id

Fetch one report by its id (the public report UUID).

Rate limits follow your plan (daily + monthly caps, plus any top-up credits). A 429 from a target site surfaces as status: failed.

Get your token →