Skip to main content

Error Model

Status codes:

  • 200 OK: Successful operations
  • 400 Bad Request: Validation or malformed input
  • 401 Unauthorized: Missing/invalid credentials (if endpoint requires)
  • 404 Not Found: Missing resource
  • 409 Conflict: Concurrent modification, unique constraints
  • 500 Internal Server Error: Unexpected failures

Shape:

{
"error": {
"code": "validation_error",
"message": "name is required",
"details": { "field": "name" }
}
}

Guidelines:

  • Return consistent JSON errors with code and human-readable message.
  • Avoid leaking sensitive internals in error responses.
  • Log server-side errors with request correlation ids when possible.