POST Content Generation API
/api/v1/ai/content-generation
Generate marketing copy, blogs, social captions, and product content from a short prompt.
Architecture Role & AI Definition
Content 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 | Instruction or writing prompt (Max: 15,000 characters) |
tone |
string | Optional | Tone style such as "professional", "friendly", "persuasive" (Max: 50 chars) |
format |
string | Optional | Content format such as "blog_post", "social_caption", "email" (Max: 50 chars) |
audience |
string | Optional | Target audience for the content (e.g., "developers", "teenagers") (Max: 100 chars) |
Important Note on Credit Usage
All fields you pass in the request (such as prompt, tone, format, and audience) are sent to the AI and count towards your total Content Size (Input Characters). Additionally, the generated content length affects output billing. Be mindful of passing excessively long prompts to avoid higher processing credit costs.
Example Request
{
"prompt": "Write a launch announcement for our new AI API platform.",
"format": "social_caption",
"tone": "professional",
"audience": "developers"
}curl -X POST https://rsflowhub.com/api/v1/ai/content-generation \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "Write a launch announcement for our new AI API platform.",
"format": "social_caption",
"tone": "professional",
"audience": "developers"
}'Example Response
{
"success": true,
"data": {
"result": {
"content": "🚀 We are thrilled to launch RSFlowHub APIs! Build AI features into your apps in minutes with our robust, pay-as-you-go infrastructure. Designed for developers who want to ship fast."
}
},
"meta": {
"credits_used": 6,
"credits_remaining": 994
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/content-generation' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"prompt": "Write a launch announcement for our new AI API platform.",
"format": "social_caption",
"tone": "professional",
"audience": "developers"
}'Store both your original prompt and generated output for auditing and quality iteration.
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 (2 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. |