Run an agent-readiness check on a domain
POST /api/v1/checks
Authentication: None.
Body: application/json, schema check-input.
| Status | Meaning |
|---|---|
| 200 | Summary, findings, and how to unlock the full report |
| 422 | Problem |
| 429 | Problem |
| 503 | Problem |
A readiness report by id (the id is the link); full detail once unlocked
GET /api/v1/checks/{id}
Authentication: None.
| Parameter | In | Required | Notes |
|---|---|---|---|
id | path | yes | Report UUID |
| Status | Meaning |
|---|---|
| 200 | OK |
| 404 | Problem |
| 503 | Problem |
Pay to unlock a report, or buy a pack of credits
POST /api/v1/checks/{id}/checkout
Authentication: None.
| Parameter | In | Required | Notes |
|---|---|---|---|
id | path | yes |
Body: application/json, schema check-checkout.
| Status | Meaning |
|---|---|
| 200 | Stripe client secret |
| 404 | Problem |
| 409 | Problem |
| 422 | Problem |
| 429 | Problem |
| 503 | Problem |
Unlock a report with a credit code from a pack
POST /api/v1/checks/{id}/redeem
Authentication: None.
| Parameter | In | Required | Notes |
|---|---|---|---|
id | path | yes |
Body: application/json, schema check-redeem.
| Status | Meaning |
|---|---|
| 200 | Unlocked, with credits remaining |
| 404 | Problem |
| 409 | Problem |
| 422 | Problem |
| 429 | Problem |
| 503 | Problem |