Skip to content
ideogram-install-auth logo

Ideogram Install & Auth

ideogram-install-auth

Install and configure Ideogram API authentication.

SKILL.md

Full skill instructions

Ideogram Install & Auth

Overview

Set up Ideogram API authentication for AI image generation. Ideogram provides a REST API at api.ideogram.ai for text-to-image generation, editing, remixing, upscaling, and describing images. Authentication uses an Api-Key header on every request.

Prerequisites

  • Node.js 18+ or Python 3.10+
  • Ideogram account at ideogram.ai
  • API key from Ideogram dashboard (Settings > API Beta)
  • Payment method configured (auto top-up billing)

Instructions

Step 1: Get Your API Key

  1. Log into ideogram.ai
  2. Navigate to Settings (burger icon) > API Beta
  3. Accept the Developer API Agreement
  4. Click Manage Payment and add billing info via Stripe
  5. Click Create API key -- store it immediately, it is shown only once

Step 2: Install HTTP Client

set -euo pipefail
# Node.js (no SDK required -- Ideogram uses a plain REST API)
npm install dotenv

# Python
pip install requests python-dotenv

Step 3: Configure Authentication

# Create .env file (NEVER commit to git)
echo 'IDEOGRAM_API_KEY=your-api-key-here' >> .env

# Add to .gitignore
echo '.env' >> .gitignore
echo '.env.local' >> .gitignore

Step 4: Verify Connection

// verify-ideogram.ts
import "dotenv/​config";

async function verifyIdeogramAuth() {
  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: "A simple blue circle on white background",
        model: "V_2_TURBO",
        aspect_ratio: "ASPECT_1_1",
        magic_prompt_option: "OFF",
      },
    }),
  });

  if (response.ok) {
    const result = await response.json();
    console.log("Auth verified. Image URL:", result.data[0].url);
    console.log("Seed:", result.data[0].seed);
  } else {
    const err = await response.text();
    console.error(`Auth failed (${response.status}):`, err);
  }
}

verifyIdeogramAuth();
# verify_ideogram.py
import os, requests
from dotenv import load_dotenv

load_dotenv()

response = requests.post(
    "https://api.ideogram.ai/​generate",
    headers={
        "Api-Key": os.environ["IDEOGRAM_API_KEY"],
        "Content-Type": "application/​json",
    },
    json={
        "image_request": {
            "prompt": "A simple blue circle on white background",
            "model": "V_2_TURBO",
            "aspect_ratio": "ASPECT_1_1",
            "magic_prompt_option": "OFF",
        }
    },
)

if response.ok:
    data = response.json()
    print("Auth verified. Image URL:", data["data"][0]["url"])
else:
    print(f"Auth failed ({response.status_code}):", response.text)

API Base URLs

API VersionBase URLNotes
Legacy (V_2)https://api.ideogram.ai/​generateJSON body with image_request wrapper
V3 Generatehttps://api.ideogram.ai/​v1/​ideogram-v3/​generateMultipart form data
V3 Edithttps://api.ideogram.ai/​v1/​ideogram-v3/​editMultipart form data
V3 Remixhttps://api.ideogram.ai/​v1/​ideogram-v3/​remixMultipart form data
V3 Reframehttps://api.ideogram.ai/​v1/​ideogram-v3/​reframeMultipart form data
Upscalehttps://api.ideogram.ai/​upscaleMultipart form data
Describehttps://api.ideogram.ai/​describeMultipart form data

Billing Model

  • Auto top-up: balance refills to $20 when it drops below $10 (configurable)
  • Default rate limit: 10 in-flight requests
  • Image URLs expire -- download immediately after generation
  • Enterprise: contact [email protected] for higher limits

Error Handling

ErrorHTTP StatusCauseSolution
Invalid API Key401Key missing or revokedVerify key in dashboard, regenerate if needed
Rate Limited429Exceeded 10 in-flight requestsQueue requests, add backoff
Insufficient Credits402Balance depletedTop up via dashboard billing
Safety Rejected422Prompt or image failed safety checkRephrase prompt, remove flagged content

Output

  • Environment variable IDEOGRAM_API_KEY configured
  • .env file with key (git-ignored)
  • Successful test generation confirming connectivity

Resources

Next Steps

After successful auth, proceed to ideogram-hello-world for your first real generation.

More skills from jeremylongshore

openrouter-compliance-review logo
jeremylongshore/claude-code-plugins-plus-skills

openrouter-compliance-review

Review OpenRouter integration for regulatory compliance (SOC2, GDPR,

2.8K 0
View
maintainx-data-handling logo
jeremylongshore/claude-code-plugins-plus-skills

maintainx-data-handling

Data synchronization, ETL patterns, and data management for MaintainX.

2.8K 0
View
groq-core-workflow-a logo
jeremylongshore/claude-code-plugins-plus-skills

groq-core-workflow-a

Execute Groq primary workflow: chat completions with tool use and JSON

2.8K 0
View
validating-csrf-protection logo
jeremylongshore/claude-code-plugins-plus-skills

validating-csrf-protection

Validate CSRF protection implementations for security gaps. Use when

2.8K 0
View
api-contract logo
jeremylongshore/claude-code-plugins-plus-skills

api-contract

Configure this skill should be used when the user asks about "API contract",

2.8K 0
View
ideogram-incident-runbook logo
jeremylongshore/claude-code-plugins-plus-skills

ideogram-incident-runbook

Execute Ideogram incident response with triage, mitigation, and postmortem.

2.8K 0
View
gamma-sdk-patterns logo
jeremylongshore/claude-code-plugins-plus-skills

gamma-sdk-patterns

Reusable patterns for the Gamma REST API (no SDK exists).

2.8K 0
View
deepgram-sdk-patterns logo
jeremylongshore/claude-code-plugins-plus-skills

deepgram-sdk-patterns

Apply production-ready Deepgram SDK patterns for TypeScript and Python.

2.8K 0
View
openrouter-upgrade-migration logo
jeremylongshore/claude-code-plugins-plus-skills

openrouter-upgrade-migration

Migrate to OpenRouter from direct provider APIs or upgrade between SDK/model

2.8K 0
View
openrouter-common-errors logo
jeremylongshore/claude-code-plugins-plus-skills

openrouter-common-errors

Diagnose and fix common OpenRouter API errors. Use when encountering

2.8K 0
View
linear-cost-tuning logo
jeremylongshore/claude-code-plugins-plus-skills

linear-cost-tuning

Optimize Linear API usage, reduce unnecessary calls, and maximize

2.8K 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View