Error handling

Integration endpoints return standard HTTP status codes. JSON error bodies use:

json
{ "error": "Human-readable message" }

Validation errors may include code and details:

json
{
  "error": "validation failed",
  "code": "validation_failed",
  "details": {}
}

Status codes

CodeMeaningWhat to do
400Invalid JSON or bad parametersCheck templateId format and request body
401Missing or invalid API keyVerify key header and that the key is not revoked
403JWT supplied or missing permissionUse X-Api-Key with render.execute
404Template not found in your orgConfirm templateId is a template UUID, not a version UUID
422Template version not approvedApprove the version in the admin app first
429Render quota exceededRetry later or contact support
500Server errorRetry with backoff; include X-Request-ID when reporting issues

Response header

All responses include X-Request-ID for support and log correlation.