ideogram-sdk-patterns

•

1.9k2643 months ago

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".

Quick Install

npxskills add jeremylongshore/claude-code-plugins-plus-skills--skill ideogram-sdk-patterns

Instructions

Ideogram SDK Patterns

Overview

Production-ready patterns for Ideogram's REST API. Since Ideogram has no official SDK, these patterns provide type-safe wrappers, retry logic, response validation, and multi-tenant support for the api.ideogram.ai endpoints.

Prerequisites

Completed ideogram-install-auth setup
Familiarity with async/await and fetch API
Understanding of Ideogram response lifecycle (URLs expire)

Instructions

Step 1: Singleton Client with Auto-Download

// src/ideogram/client.ts
import { writeFileSync, mkdirSync } from "fs";
import { join } from "path";

const API_BASE = "https://api.ideogram.ai";

let instance: IdeogramClient | null = null;

export function getIdeogramClient(): IdeogramClient {
  if (!instance) {
    const key = process.env.IDEOGRAM_API_KEY;
    if (!key) throw new Error("IDEOGRAM_API_KEY not set");
    instance = new IdeogramClient(key);
  }
  return instance;
}

export class IdeogramClient {
  constructor(private apiKey: string) {}

  async generate(prompt: string, options: {
    model?: string;
    style_type?: string;
    aspect_ratio?: string;
    negative_prompt?: string;
    magic_prompt_option?: string;
    num_images?: number;
    seed?: number;
  } = {}) {
    const response = await fetch(`${API_BASE}/generate`, {
      method: "POST",
      headers: { "Api-Key": this.apiKey, "Content-Type": "application/json" },
      body: JSON.stringify({
        image_request: {
          prompt,
          model: options.model ?? "V_2",
          style_type: options.style_type ?? "AUTO",
          aspect_ratio: options.aspect_ratio ?? "ASPECT_1_1",
          magic_prompt_option: options.magic_prompt_option ?? "AUTO",
          negative_prompt: options.negative_prompt,
          num_images: options.num_images ?? 1,
          seed: options.seed,
        },
      }),
    });
    return this.handleResponse(response);
  }

  async describe(imagePath: string) {
    const form = new FormData();
    const file = new Blob([await import("fs").then(fs => fs.readFileSync(imagePath))]);
    form.append("image_file", file, "image.png");
    const response = await fetch(`${API_BASE}/describe`, {
      method: "POST",
      headers: { "Api-Key": this.apiKey },
      body: form,
    });
    return this.handleResponse(response);
  }

  async downloadImage(url: string, outputDir: string, filename?: string): Promise<string> {
    mkdirSync(outputDir, { recursive: true });
    const imgResponse = await fetch(url);
    if (!imgResponse.ok) throw new Error(`Download failed: ${imgResponse.status}`);
    const buffer = Buffer.from(await imgResponse.arrayBuffer());
    const outPath = join(outputDir, filename ?? `ideogram-${Date.now()}.png`);
    writeFileSync(outPath, buffer);
    return outPath;
  }

  private async handleResponse(response: Response) {
    if (!response.ok) {
      const body = await response.text();
      throw new IdeogramApiError(response.status, body);
    }
    return response.json();
  }
}

export class IdeogramApiError extends Error {
  constructor(public status: number, public body: string) {
    super(`Ideogram ${status}: ${body}`);
    this.name = "IdeogramApiError";
  }
  get isRateLimited() { return this.status === 429; }
  get isSafetyRejected() { return this.status === 422; }
  get isAuthError() { return this.status === 401; }
}

Loading…

Related Skills

skill-creator

Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.

367,360

skill-creator

Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.

367,309

1password

Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.

365,915

himalaya

CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).

365,885

Tags & Topics

aiautomationclaude-codedevopsmcpai-agents

Instructions

Step 1: Singleton Client with Auto-Download

// src/ideogram/client.ts import { writeFileSync, mkdirSync } from "fs"; import { join } from "path"; const API_BASE = "https://api.ideogram.ai"; let instance: IdeogramClient | null = null; export function getIdeogramClient(): IdeogramClient { if (!instance) { const key = process.env.IDEOGRAM_API_KEY; if (!key) throw new Error("IDEOGRAM_API_KEY not set"); instance = new IdeogramClient(key); } return instance; } export class IdeogramClient { constructor(private apiKey: string) {} async generate(prompt: string, options: { model?: string; style_type?: string; aspect_ratio?: string; negative_prompt?: string; magic_prompt_option?: string; num_images?: number; seed?: number; } = {}) { const response = await fetch(`${API_BASE}/generate`, { method: "POST", headers: { "Api-Key": this.apiKey, "Content-Type": "application/json" }, body: JSON.stringify({ image_request: { prompt, model: options.model ?? "V_2", style_type: options.style_type ?? "AUTO", aspect_ratio: options.aspect_ratio ?? "ASPECT_1_1", magic_prompt_option: options.magic_prompt_option ?? "AUTO", negative_prompt: options.negative_prompt, num_images: options.num_images ?? 1, seed: options.seed, }, }), }); return this.handleResponse(response); } async describe(imagePath: string) { const form = new FormData(); const file = new Blob([await import("fs").then(fs => fs.readFileSync(imagePath))]); form.append("image_file", file, "image.png"); const response = await fetch(`${API_BASE}/describe`, { method: "POST", headers: { "Api-Key": this.apiKey }, body: form, }); return this.handleResponse(response); } async downloadImage(url: string, outputDir: string, filename?: string): Promise<string> { mkdirSync(outputDir, { recursive: true }); const imgResponse = await fetch(url); if (!imgResponse.ok) throw new Error(`Download failed: ${imgResponse.status}`); const buffer = Buffer.from(await imgResponse.arrayBuffer()); const outPath = join(outputDir, filename ?? `ideogram-${Date.now()}.png`); writeFileSync(outPath, buffer); return outPath; } private async handleResponse(response: Response) { if (!response.ok) { const body = await response.text(); throw new IdeogramApiError(response.status, body); } return response.json(); } } export class IdeogramApiError extends Error { constructor(public status: number, public body: string) { super(`Ideogram ${status}: ${body}`); this.name = "IdeogramApiError"; } get isRateLimited() { return this.status === 429; } get isSafetyRejected() { return this.status === 422; } get isAuthError() { return this.status === 401; } }

Pattern	Use Case	Benefit
Singleton	Shared client across modules	Single connection, consistent config
Retry wrapper	Rate limits and transient errors	Automatic recovery from 429/5xx
Zod validation	Response validation	Catches API changes at parse time
Auto-download	Image persistence	Prevents URL expiry data loss
Multi-tenant	SaaS platforms	Per-customer API key isolation

ideogram-sdk-patterns

Ideogram SDK Patterns

Overview

Prerequisites

Instructions

Step 1: Singleton Client with Auto-Download

Related Skills

skill-creator

skill-creator

1password

himalaya

skill-creator

skill-creator

1password

himalaya

Ideogram SDK Patterns

Overview

Prerequisites

Instructions

Step 1: Singleton Client with Auto-Download

Step 2: Retry with Exponential Backoff

Step 3: Response Validation with Zod

Step 4: Python Client

Step 5: Multi-Tenant Factory

Error Handling

Output

Resources

Next Steps

Related Skills

skill-creator

skill-creator

1password

himalaya

Related Skills

skill-creator

skill-creator

1password

himalaya