home / skills / jeremylongshore / claude-code-plugins-plus-skills / ideogram-install-auth

This skill installs the Ideogram SDK/CLI and configures authentication to streamline setup of Ideogram integrations.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill ideogram-install-auth

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.2 KB
---
name: ideogram-install-auth
description: |
  Install and configure Ideogram SDK/CLI authentication.
  Use when setting up a new Ideogram integration, configuring API keys,
  or initializing Ideogram in your project.
  Trigger with phrases like "install ideogram", "setup ideogram",
  "ideogram auth", "configure ideogram API key".
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pip:*), Grep
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# Ideogram Install & Auth

## Overview
Set up Ideogram SDK/CLI and configure authentication credentials.

## Prerequisites
- Node.js 18+ or Python 3.10+
- Package manager (npm, pnpm, or pip)
- Ideogram account with API access
- API key from Ideogram dashboard

## Instructions

### Step 1: Install SDK
```bash
# Node.js
npm install @ideogram/sdk

# Python
pip install ideogram
```

### Step 2: Configure Authentication
```bash
# Set environment variable
export IDEOGRAM_API_KEY="your-api-key"

# Or create .env file
echo 'IDEOGRAM_API_KEY=your-api-key' >> .env
```

### Step 3: Verify Connection
```typescript
// Test connection code here
```

## Output
- Installed SDK package in node_modules or site-packages
- Environment variable or .env file with API key
- Successful connection verification output

## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| Invalid API Key | Incorrect or expired key | Verify key in Ideogram dashboard |
| Rate Limited | Exceeded quota | Check quota at https://docs.ideogram.com |
| Network Error | Firewall blocking | Ensure outbound HTTPS allowed |
| Module Not Found | Installation failed | Run `npm install` or `pip install` again |

## Examples

### TypeScript Setup
```typescript
import { IdeogramClient } from '@ideogram/sdk';

const client = new IdeogramClient({
  apiKey: process.env.IDEOGRAM_API_KEY,
});
```

### Python Setup
```python
from ideogram import IdeogramClient

client = IdeogramClient(
    api_key=os.environ.get('IDEOGRAM_API_KEY')
)
```

## Resources
- [Ideogram Documentation](https://docs.ideogram.com)
- [Ideogram Dashboard](https://api.ideogram.com)
- [Ideogram Status](https://status.ideogram.com)

## Next Steps
After successful auth, proceed to `ideogram-hello-world` for your first API call.

Overview

This skill installs the Ideogram SDK/CLI and configures authentication so your app can call Ideogram APIs. It walks through required prerequisites, package installation for Node.js or Python, and secure API key setup. The goal is a verified client ready for development and testing.

How this skill works

The skill guides you to install the official Ideogram package for your environment (npm or pip), set an IDEOGRAM_API_KEY as an environment variable or in a .env file, and run a simple verification call. It explains common error messages and remediation steps so you can confirm successful connectivity. Sample code for TypeScript and Python shows how to instantiate the Ideogram client using the configured key.

When to use it

  • Setting up a new project that will call Ideogram services
  • Adding Ideogram integration to an existing app or CI pipeline
  • Configuring API keys for local development or deployment
  • Troubleshooting authentication or connection failures
  • Preparing a dev environment before running Ideogram tutorials or samples

Best practices

  • Use Node.js 18+ or Python 3.10+ and a supported package manager (npm, pnpm, pip)
  • Store API keys in environment variables or a .env file; avoid committing keys to version control
  • Verify the API key on the Ideogram dashboard if authentication fails
  • Run a small verification request after installation to confirm connectivity and permissions
  • Monitor usage and quotas to avoid rate limiting; implement exponential backoff on retries

Example use cases

  • Install @ideogram/sdk in a frontend or backend Node project and set IDEOGRAM_API_KEY for runtime
  • Install ideogram Python package in a data pipeline and read API key from environment for auth
  • Add a CI job that injects IDEOGRAM_API_KEY as a secret and runs smoke tests against Ideogram
  • Troubleshoot a 'Module Not Found' by re-running the package installer and checking PATH
  • Resolve 'Invalid API Key' by regenerating or copying the key from the Ideogram dashboard

FAQ

What if I see 'Invalid API Key' after configuring the variable?

Confirm the key value on the Ideogram dashboard, ensure the environment variable name is IDEOGRAM_API_KEY, and restart your process so the new variable is loaded.

How do I avoid committing API keys to git?

Add .env to .gitignore and use environment-specific secret storage for CI and production deployments.