Ideogram Production Checklist
Overview
Complete pre-flight checklist for deploying Ideogram image generation to production. Covers API key management, timeout configuration, image persistence, error handling, monitoring, and rollback procedures.
Prerequisites
- Staging environment tested
- Production API key created (separate from dev)
- Image storage configured (S3, GCS, or R2)
- Monitoring stack ready
Pre-Deployment Checklist
API Configuration
Request Handling
Image Persistence
Error Handling
Content Safety
Production Health Check
async function ideogramHealthCheck(): Promise<{
status: "healthy" | "degraded" | "down";
latencyMs: number;
details: string;
}> {
const start = Date.now();
try {
const response = await fetch("https://api.ideogram.ai/generate", {
method: "POST",
headers: {
"Api-Key": process.env.IDEOGRAM_API_KEY!,
"Content-Type": "application/json",
},
body: JSON.stringify({
image_request: {
prompt: "health check: simple blue dot",
model: "V_2_TURBO",
magic_prompt_option: "OFF",
},
}),
signal: AbortSignal.timeout(30000),
});
const latencyMs = Date.now() - start;
if (response.ok) {
return { status: "healthy", latencyMs, : };
}
(response. === ) {
{ : , latencyMs, : };
}
{ : , latencyMs, : };
} (: ) {
{ : , : .() - start, : err. };
}
}
Deployment Script
set -euo pipefail
echo "=== Ideogram Pre-Flight Checks ==="
STATUS=$(curl -s -o /dev/null -w "%{http_code}" \
-X POST https://api.ideogram.ai/generate \
-H "Api-Key: $IDEOGRAM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image_request":{"prompt":"deploy check","model":"V_2_TURBO","magic_prompt_option":"OFF"}}')
if [ "$STATUS" != "200" ]; then
echo "FAIL: API returned $STATUS"
exit 1
fi
echo "PASS: API key valid (HTTP $STATUS)"
IMAGE_URL=$(curl -s -X POST https://api.ideogram.ai/generate \
-H "Api-Key: $IDEOGRAM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image_request":{"prompt":"deploy check","model":"V_2_TURBO","magic_prompt_option":"OFF"}}' \
| jq -r '.data[0].url')
DL_STATUS=$(curl -s -o /dev/null -w "%{http_code}" "$IMAGE_URL")
echo "PASS: Image download works (HTTP $DL_STATUS)"
echo "=== All pre-flight checks passed ==="
Alerting Rules
| Alert | Condition | Severity |
|---|
| API Unreachable | Health check returns down | P1 |
| Auth Failure | Any 401 response | P1 |
| Rate Limited | >5 consecutive 429 responses | P2 |
| Slow Generation | P95 latency > 30 seconds | P2 |
| Credits Low | Balance below $10 | P2 |
| Safety Rejections | >10% of prompts rejected | P3 |
Rollback Procedure
set -euo pipefail
kubectl set env deployment/app IDEOGRAM_ENABLED=false
kubectl rollout restart deployment/app
curl -s https://app.example.com/health | jq '.services.ideogram'
kubectl set env deployment/app IDEOGRAM_ENABLED=true
kubectl rollout restart deployment/app
Error Handling
| Alert | Condition | Action |
|---|
| API Down | 5xx or timeout | Enable fallback, notify on-call |
| Key Revoked | 401 | Rotate key, update secrets |
| Credits Empty | 402 | Top up billing, pause batch jobs |
| Rate Flood | 429 sustained | Reduce concurrency, queue jobs |
Output
- All checklist items verified
- Health check endpoint configured
- Alerting rules deployed
- Rollback procedure tested
Resources
Next Steps
For version upgrades, see ideogram-upgrade-migration.
