WebProbe v1.0.0 · API v1
API and authentication
All /v1 routes require Authorization: Bearer wp_…. Keys map to a client principal and only a SHA-256 digest is stored. Revoked and suspended credentials fail with 401.
POST /v1/run
The same contract selects HTTP, browser, or crawler execution. Browser requirements—actions, rendering, UI assertions, interception, traces—should set browser: true. Set mode: async to receive 202 and poll the job.
| Concern | Fields |
|---|---|
| Target | url, method, headers, body, request |
| Browser state | browser, cookies, storage, session, network |
| Workflow | wait, wait_for, wait_until, actions |
| Data | extract, validate, crawl |
| QA | mock, intercept, modify_response, assert |
| Diagnostics | capture |
| Delivery | mode, webhook |
Every response includes X-Request-Id. execution_status reports infrastructure/execution completion; test_status separately reports assertions and contracts.
Jobs and usage
GET /v1/jobs/:idreturns explicit queued, assigned, running, completed, failed, cancelled, or expired state.GET /v1/usagereturns current-month request, browser-second, and artifact-byte usage.Idempotency-Keydeduplicates async creation per authenticated principal for 24 hours.