Error Response Format
All errors follow this format:| Field | Type | Description |
|---|---|---|
message | string | Human-readable description of the error |
code | string | Machine-readable error code |
Error Codes
Validation Errors (400)
Returned when request parameters are invalid or missing.| Code | Description |
|---|---|
INVALID_GENERATION_TYPE | generation_type must be "image" or "video" |
INVALID_ALPHA_MODE | alpha_mode must be "auto", "fill", "custom", or "select" |
INVALID_MAX_RESOLUTION | max_resolution must be 720 or 1080 |
MISSING_STYLE_INPUT | Neither reference_image_uri nor prompt was provided |
MISSING_SOURCE | source_uri is required |
MISSING_ALPHA | alpha_uri required when alpha_mode is "custom" or "select" |
INVALID_FILE_FORMAT | Source format doesn’t match generation_type (e.g. video source for image generation) |
ALPHA_TYPE_MISMATCH | Alpha type doesn’t match source (image vs video) when alpha_mode is "custom" |
ALPHA_MUST_BE_IMAGE | Alpha must be an image (PNG/JPG) when alpha_mode is "select" |
SOURCE_TOO_LARGE | Source resolution exceeds 2,770,000 total pixels (width × height) |
VIDEO_TOO_MANY_FRAMES | Video exceeds the maximum of 240 frames |
INVALID_URI | URI format invalid or file type could not be determined |
SOURCE_UNREACHABLE | Source, alpha, or reference URI is not reachable |
INVALID_FILENAME | Filename invalid or unsupported extension |
INVALID_CALLBACK_URL | Callback URL is not valid HTTPS or is unreachable |
Authentication Errors (401)
Returned when API key authentication fails.| Code | Description |
|---|---|
INVALID_API_KEY | API key is missing or invalid |
Billing Errors (402)
Returned when there is a billing or payment issue with your account.| Code | Description |
|---|---|
CREDIT_DEDUCTION_FAILED | No billing account or no active API subscription |
Not Found Errors (404)
Returned when the requested resource doesn’t exist.| Code | Description |
|---|---|
JOB_NOT_FOUND | Job doesn’t exist or is not owned by you |
Rate Limiting (429)
Returned when you exceed the request rate limit.| Code | Description |
|---|---|
RATE_LIMIT_EXCEEDED | Too many requests |
Server Errors (500)
Returned when an internal error occurs. These are not caused by your request.| Code | Description |
|---|---|
INTERNAL_ERROR | Unexpected server error |
CREDIT_DEDUCTION_FAILED | Failed to process credit deduction |
UPLOAD_URL_FAILED | Failed to generate upload URL |
JOB_QUEUE_FAILED | Failed to queue job for processing |