hzel Docs

Error Envelope

All API errors return a consistent JSON shape:

{
  "error": {
    "code": "CONTAINER_NOT_FOUND",
    "message": "The requested container does not exist"
  }
}

The HTTP status code accompanies the response (e.g., 404).

Successful responses wrap the payload in a data field:

{
  "data": { }
}

Code	HTTP Status	Description
`UNAUTHORIZED`	401	Missing or invalid authentication token.
`FORBIDDEN`	403	Authenticated but insufficient permissions.
`CSRF_REJECTED`	403	Request is missing a valid CSRF token.
`BAD_REQUEST`	400	Malformed request.
`VALIDATION_FAILED`	400	Request body failed validation.
`NOT_FOUND`	404	Requested resource does not exist.
`CONTAINER_NOT_FOUND`	404	The specified container ID does not exist.
`COMMAND_NOT_FOUND`	404	The specified command job ID does not exist.
`NOT_IMPLEMENTED`	501	Endpoint is reserved or not yet available.
`INTERNAL_ERROR`	500	Unexpected server error.

Status	Meaning
`200`	Success — response body contains `{ "data": … }`.
`204`	Success — no response body.
`302`	Redirect (used by OAuth flows).
`400`	Bad request — validation error.
`401`	Unauthorized — missing or expired token.
`403`	Forbidden — insufficient role or access level.
`404`	Not found.
`501`	Not implemented.
`500`	Internal server error.