ideogram-install-auth
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".
When & Why to Use This Skill
The Ideogram Install & Auth skill streamlines the initial setup of the Ideogram SDK and CLI for developers. It automates the installation of necessary packages for Node.js and Python environments, manages API key configuration through environment variables or .env files, and provides connection verification to ensure the development environment is ready for AI image generation tasks.
Use Cases
- Initial Project Setup: Quickly bootstrap a new project by installing the Ideogram SDK and configuring the required API credentials in one step.
- Environment Configuration: Securely manage and inject Ideogram API keys into local development environments or server configurations using .env files.
- Connectivity Troubleshooting: Diagnosing and resolving authentication issues by re-running the configuration and verification process to ensure valid API access.
| name | ideogram-install-auth |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit, Bash(npm:*), Bash(pip:*), Grep |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
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
# Node.js
npm install @ideogram/sdk
# Python
pip install ideogram
Step 2: Configure Authentication
# 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
// 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
import { IdeogramClient } from '@ideogram/sdk';
const client = new IdeogramClient({
apiKey: process.env.IDEOGRAM_API_KEY,
});
Python Setup
from ideogram import IdeogramClient
client = IdeogramClient(
api_key=os.environ.get('IDEOGRAM_API_KEY')
)
Resources
Next Steps
After successful auth, proceed to ideogram-hello-world for your first API call.