Assess API · v1
Errors
All error responses follow a consistent format with a machine-readable code and a human-readable message.
GET
https://praxicraft.com/api/v1/public/...Auth: —
Error Response Format
Error responses always return a JSON body with an `error` object containing a `message` and optional `code`.
Response Fields
| Field | Type | Description |
|---|---|---|
| error.message | string | Human-readable explanation |
| error.code | string | Machine-readable code (see table below) |
Example Response
JSON
// 401 — Missing or invalid API key
{
"error": {
"message": "Invalid API key.",
"code": "INVALID_API_KEY"
}
}
// 400 — Validation error
{
"error": {
"message": "email is required",
"code": "MISSING_EMAIL"
}
}
// 404 — Resource not found
{
"error": {
"message": "Assessment not found.",
"code": "NOT_FOUND"
}
}
// 403 — Invite quota exceeded
{
"error": {
"message": "Monthly invite quota exceeded. Upgrade your plan to invite more candidates.",
"code": "INVITE_QUOTA_EXCEEDED"
}
}
// 400 — Assessment not in active status
{
"error": {
"message": "This assessment is not active and cannot accept new invitations.",
"code": "ASSESSMENT_NOT_ACTIVE"
}
}
// 429 — Rate limited
{
"error": {
"message": "Request was throttled. Expected available in 8 seconds."
}
}