ideogram-sdk-patterns
Apply production-ready Ideogram SDK patterns for TypeScript and Python.Use when implementing Ideogram integrations, refactoring SDK usage,or establishing team coding standards for Ideogram.Trigger with phrases like "ideogram SDK patterns", "ideogram best practices","ideogram code patterns", "idiomatic ideogram".
When & Why to Use This Skill
This Claude skill provides production-ready design patterns and best practices for integrating the Ideogram SDK in TypeScript and Python. It streamlines the development of robust AI-powered applications by offering idiomatic code structures for client management, error handling, and resilient API communication, ensuring high maintainability and performance.
Use Cases
- Implementing a singleton client pattern to optimize resource usage and manage Ideogram API connections efficiently across a TypeScript or Python backend.
- Enhancing application reliability by integrating exponential backoff retry logic and structured error handling to gracefully manage transient Ideogram API failures.
- Establishing organizational coding standards for Ideogram integrations using type-safe Zod schemas and validated response patterns to prevent runtime errors.
- Developing multi-tenant systems that require dynamic client instantiation and secure API key management via the Factory pattern for scalable architecture.
| name | ideogram-sdk-patterns |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Ideogram SDK Patterns
Overview
Production-ready patterns for Ideogram SDK usage in TypeScript and Python.
Prerequisites
- Completed
ideogram-install-authsetup - Familiarity with async/await patterns
- Understanding of error handling best practices
Instructions
Step 1: Implement Singleton Pattern (Recommended)
// src/ideogram/client.ts
import { IdeogramClient } from '@ideogram/sdk';
let instance: IdeogramClient | null = null;
export function getIdeogramClient(): IdeogramClient {
if (!instance) {
instance = new IdeogramClient({
apiKey: process.env.IDEOGRAM_API_KEY!,
// Additional options
});
}
return instance;
}
Step 2: Add Error Handling Wrapper
import { IdeogramError } from '@ideogram/sdk';
async function safeIdeogramCall<T>(
operation: () => Promise<T>
): Promise<{ data: T | null; error: Error | null }> {
try {
const data = await operation();
return { data, error: null };
} catch (err) {
if (err instanceof IdeogramError) {
console.error({
code: err.code,
message: err.message,
});
}
return { data: null, error: err as Error };
}
}
Step 3: Implement Retry Logic
async function withRetry<T>(
operation: () => Promise<T>,
maxRetries = 3,
backoffMs = 1000
): Promise<T> {
for (let attempt = 1; attempt <= maxRetries; attempt++) {
try {
return await operation();
} catch (err) {
if (attempt === maxRetries) throw err;
const delay = backoffMs * Math.pow(2, attempt - 1);
await new Promise(r => setTimeout(r, delay));
}
}
throw new Error('Unreachable');
}
Output
- Type-safe client singleton
- Robust error handling with structured logging
- Automatic retry with exponential backoff
- Runtime validation for API responses
Error Handling
| Pattern | Use Case | Benefit |
|---|---|---|
| Safe wrapper | All API calls | Prevents uncaught exceptions |
| Retry logic | Transient failures | Improves reliability |
| Type guards | Response validation | Catches API changes |
| Logging | All operations | Debugging and monitoring |
Examples
Factory Pattern (Multi-tenant)
const clients = new Map<string, IdeogramClient>();
export function getClientForTenant(tenantId: string): IdeogramClient {
if (!clients.has(tenantId)) {
const apiKey = getTenantApiKey(tenantId);
clients.set(tenantId, new IdeogramClient({ apiKey }));
}
return clients.get(tenantId)!;
}
Python Context Manager
from contextlib import asynccontextmanager
from ideogram import IdeogramClient
@asynccontextmanager
async def get_ideogram_client():
client = IdeogramClient()
try:
yield client
finally:
await client.close()
Zod Validation
import { z } from 'zod';
const ideogramResponseSchema = z.object({
id: z.string(),
status: z.enum(['active', 'inactive']),
createdAt: z.string().datetime(),
});
Resources
Next Steps
Apply patterns in ideogram-core-workflow-a for real-world usage.