POST Image Generation API
/api/v1/ai/image-generation
Generate marketing visuals and product creatives from text prompts.
Architecture Role & AI Definition
Image Generation API provides low-latency, deterministic REST execution for production engineering workflows. It processes structured payloads with strict schema validation, returns uniform JSON envelopes, and is secured via SHA-256 API key authentication with atomic credit pre-authorization locks.
Production Reliability Guidelines
Configure a hard client timeout of 5 to 8 seconds. If network latency spikes, cancel connection to avoid holding open sockets in worker pools.
Upon receiving 429 Rate Limit or transient 5xx, pause with exponential backoff:
wait = min(max_backoff, base * 2^attempt + jitter).
RSFlowHub acquires an atomic lock verifying base credits before model invocation. If validation fails, zero credits are deducted.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
prompt |
string | Required | Image generation prompt (Max: 4,000 chars) |
style |
string | Optional | Visual style, e.g. "photorealistic", "illustration", "3d_render" |
size |
string | Optional | Output size, e.g. "1024x1024", "1024x1792" |
n |
integer | Optional | Number of images to generate (1 to 4) |
Important Note on Credit Usage
Image Generation is a high-cost endpoint. Your Processing Credits will be multiplied directly by the number of images requested (n) and the requested size. Requesting 4 large images in a single call will consume significantly more credits than a single default-sized image.
Example Request
{
"prompt": "Clean product hero image for a developer API dashboard",
"style": "photorealistic",
"size": "1024x1024",
"n": 2
}
curl -X POST https://rsflowhub.com/api/v1/ai/image-generation \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "Clean product hero image for a developer API dashboard",
"style": "photorealistic",
"size": "1024x1024",
"n": 2
}'
Example Response
{
"success": true,
"data": {
"result": {
"images": [
"https://ai-storage.rsflowhub.com/generated/img_abc123.png",
"https://ai-storage.rsflowhub.com/generated/img_xyz789.png"
]
}
},
"meta": {
"credits_used": 40,
"credits_remaining": 960
}
}
API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/image-generation' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"prompt": "Clean product hero image for a developer API dashboard",
"style": "photorealistic",
"size": "1024x1024",
"n": 2
}'
Common Failure Modes & Troubleshooting Matrix
| HTTP Code | Error Code | Root Cause | Recommended Remediation |
|---|---|---|---|
| 400 | bad_request |
Malformed JSON syntax or missing required top-level parameters. | Validate JSON payload with Content-Type: application/json and ensure all required fields are present. |
| 401 | unauthorized |
Missing, revoked, or incorrectly formatted x-api-key header. |
Verify API key exists in Dashboard → API Keys and pass in x-api-key or Authorization: Bearer. |
| 402 | insufficient_credits |
Account credit balance is lower than the base required credits (5 credits). | Top up credits in billing settings or enable auto-recharge to prevent pipeline interruption. |
| 422 | validation_error |
Input failed parameter constraints (e.g., character length exceeded or invalid array types). | Review parameters table above and adjust payload length, types, or structure accordingly. |
| 429 | rate_limit_exceeded |
Concurrency limit (60 requests/minute default) reached for this endpoint key. | Back off and retry using the timestamp in Retry-After response header, or batch requests. |