API
Send requests to /api/v1 with the header Authorization: Bearer uxp_.... Create a key in your account. The limit is 60 requests a minute.
Start a run
curl -X POST $BASE/api/v1/runs \
-H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"site":"SITE_ID","steps":20,"concurrency":3,"personas":["p01","p03"]}'Leave out personas to use everyone enabled on the panel. Response: {"id":"r...","status":"queued","credits":2}
Methods
| Method | Path | What it does |
|---|---|---|
| GET | /balance | Credit balance |
| GET | /sites | Your sites, their ids and panels |
| GET | /personas | The persona library |
| GET | /runs | Latest runs |
| POST | /runs | Start a run |
| GET | /runs/{id} | Status and results per persona |
| POST | /runs/{id}/cancel | Cancel, unfinished credits come back |
Errors
Format: {"error":{"code":"...","message":"..."}}
| HTTP | Code | Meaning |
|---|---|---|
| 400 | no_personas | No persona picked, or an id is not on this site |
| 400 | not_test_host | Test payment mode needs a start page on a test host |
| 401 | unauthorized | Missing or invalid key |
| 402 | insufficient_credits | Not enough credits |
| 403 | domain_not_verified | Domain not verified |
| 404 | not_found | Nothing like that on your account |
| 409 | too_many_runs | Too many runs in the queue |
| 429 | rate_limited | Request limit exceeded |
What a run does to your site
Only GET requests to the verified domain. Forms are not sent and password and card fields stay empty, so a run never registers, signs in or pays. The exception is test payment mode, which you turn on for a test host. Notes come from a model, check them before you act.