Ideogram Deploy Integration
Overview
Deploy Ideogram-powered applications to popular platforms with proper secrets management.
Prerequisites
- •Ideogram API keys for production environment
- •Platform CLI installed (vercel, fly, or gcloud)
- •Application code ready for deployment
- •Environment variables documented
Vercel Deployment
Environment Setup
bash
# Add Ideogram secrets to Vercel vercel secrets add ideogram_api_key sk_live_*** vercel secrets add ideogram_webhook_secret whsec_*** # Link to project vercel link # Deploy preview vercel # Deploy production vercel --prod
vercel.json Configuration
json
{
"env": {
"IDEOGRAM_API_KEY": "@ideogram_api_key"
},
"functions": {
"api/**/*.ts": {
"maxDuration": 30
}
}
}
Fly.io Deployment
fly.toml
toml
app = "my-ideogram-app" primary_region = "iad" [env] NODE_ENV = "production" [http_service] internal_port = 3000 force_https = true auto_stop_machines = true auto_start_machines = true
Secrets
bash
# Set Ideogram secrets fly secrets set IDEOGRAM_API_KEY=sk_live_*** fly secrets set IDEOGRAM_WEBHOOK_SECRET=whsec_*** # Deploy fly deploy
Google Cloud Run
Dockerfile
dockerfile
FROM node:20-slim WORKDIR /app COPY package*.json ./ RUN npm ci --only=production COPY . . CMD ["npm", "start"]
Deploy Script
bash
#!/bin/bash
# deploy-cloud-run.sh
PROJECT_ID="${GOOGLE_CLOUD_PROJECT}"
SERVICE_NAME="ideogram-service"
REGION="us-central1"
# Build and push image
gcloud builds submit --tag gcr.io/$PROJECT_ID/$SERVICE_NAME
# Deploy to Cloud Run
gcloud run deploy $SERVICE_NAME \
--image gcr.io/$PROJECT_ID/$SERVICE_NAME \
--region $REGION \
--platform managed \
--allow-unauthenticated \
--set-secrets=IDEOGRAM_API_KEY=ideogram-api-key:latest
Environment Configuration Pattern
typescript
// config/ideogram.ts
interface IdeogramConfig {
apiKey: string;
environment: 'development' | 'staging' | 'production';
webhookSecret?: string;
}
export function getIdeogramConfig(): IdeogramConfig {
const env = process.env.NODE_ENV || 'development';
return {
apiKey: process.env.IDEOGRAM_API_KEY!,
environment: env as IdeogramConfig['environment'],
webhookSecret: process.env.IDEOGRAM_WEBHOOK_SECRET,
};
}
Health Check Endpoint
typescript
// api/health.ts
export async function GET() {
const ideogramStatus = await checkIdeogramConnection();
return Response.json({
status: ideogramStatus ? 'healthy' : 'degraded',
services: {
ideogram: ideogramStatus,
},
timestamp: new Date().toISOString(),
});
}
Instructions
Step 1: Choose Deployment Platform
Select the platform that best fits your infrastructure needs and follow the platform-specific guide below.
Step 2: Configure Secrets
Store Ideogram API keys securely using the platform's secrets management.
Step 3: Deploy Application
Use the platform CLI to deploy your application with Ideogram integration.
Step 4: Verify Health
Test the health check endpoint to confirm Ideogram connectivity.
Output
- •Application deployed to production
- •Ideogram secrets securely configured
- •Health check endpoint functional
- •Environment-specific configuration in place
Error Handling
| Issue | Cause | Solution |
|---|---|---|
| Secret not found | Missing configuration | Add secret via platform CLI |
| Deploy timeout | Large build | Increase build timeout |
| Health check fails | Wrong API key | Verify environment variable |
| Cold start issues | No warm-up | Configure minimum instances |
Examples
Quick Deploy Script
bash
#!/bin/bash
# Platform-agnostic deploy helper
case "$1" in
vercel)
vercel secrets add ideogram_api_key "$IDEOGRAM_API_KEY"
vercel --prod
;;
fly)
fly secrets set IDEOGRAM_API_KEY="$IDEOGRAM_API_KEY"
fly deploy
;;
esac
Resources
Next Steps
For webhook handling, see ideogram-webhooks-events.