All parameters should be sent in the request body as JSON.
[
{param.name},
{param.type},
{param.required ? 'Yes' : 'No'}
,
param.description,
])}
/>
Default Values: If not specified, filename is
auto-generated, aspectRatio defaults
to "1:1", and autoEnhance is false.
{/* Response */}
Response
On success, the API returns a JSON object containing the generated image URL and metadata.
{/* Error Codes */}
Error Codes
The API uses standard HTTP status codes and returns descriptive error messages.
400,
'Bad Request',
'Missing or invalid parameters in the request body',
],
[
401,
'Unauthorized',
'Missing or invalid API key in X-API-Key header',
],
[
429,
'Rate Limit',
'Too many requests. Check rate limit headers for retry timing',
],
[
500,
'Server Error',
'Internal server error. Contact support if persists',
],
]}
/>
Rate Limits: Project API keys are limited to 100 requests per hour.
Upgrade your plan for higher limits.
{/* Interactive Widget */}
Try It Live
Test the API directly from this page. Enter your API key and customize the parameters below.
{/* Next Steps */}
>
);
}