Errors
A failed request gets a 4xx or 5xx status and a JSON body that tells you what went wrong.
Error body
403 · application/json
{
"error": {
"code": "FORBIDDEN",
"message": "API key lacks the notes:write scope",
"status": 403
}
}A 400 can also have details, with the fields that are not correct. The older evaluation and webhook routes send { error: { message, code } } or a plain { error } string.
Status codes
| Status | Meaning |
|---|---|
400 BAD_REQUEST | The body or a parameter is not correct. |
401 UNAUTHORIZED | The key is missing, not correct, revoked or expired. |
403 FORBIDDEN | The key or its creator's role does not have the scope, or the monthly limit is reached. |
404 NOT_FOUND | The record does not exist, or the key's creator cannot see it. |
409 CONFLICT | The Idempotency-Key was used before with a different body. |
429 RATE_LIMITED | Too many requests. Wait for the time in Retry-After. |
500 | Server error. Try again later. |