Error handling
Integration endpoints return standard HTTP status codes. JSON error bodies use:
{ "error": "Human-readable message" }Validation errors may include code and details:
{
"error": "validation failed",
"code": "validation_failed",
"details": {}
}Status codes
| Code | Meaning | What to do |
|---|---|---|
400 | Invalid JSON or bad parameters | Check templateId format and request body |
401 | Missing or invalid API key | Verify key header and that the key is not revoked |
403 | JWT supplied or missing permission | Use X-Api-Key with render.execute |
404 | Template not found in your org | Confirm templateId is a template UUID, not a version UUID |
422 | Template version not approved | Approve the version in the admin app first |
429 | Render quota exceeded | Retry later or contact support |
500 | Server error | Retry with backoff; include X-Request-ID when reporting issues |
Response header
All responses include X-Request-ID for support and log correlation.