Help & Support

Comprehensive guides for using Insurgent Ink

Adding API Keys

Step-by-step guide to adding and configuring API keys for AI translation providers.

Before You Start

You'll need to sign up with an AI provider and generate an API key before adding it to Insurgent Ink.

Requirements

  • • Account with an AI provider (OpenAI, Anthropic, DeepL, etc.)
  • • Valid API key with translation permissions
  • • Payment method configured with the provider (if required)

Adding Your First API Key

1

Navigate to Settings

Go to your account settings and select the API Keys section.

User Menu → Settings → API Keys → Add New Key
2

Select Provider

Choose your AI provider from the dropdown list.

3

Enter API Key Details

Provide your API key and give it a descriptive name.

Choose the specific model for optimal quality/cost balance

For self-hosted models, Ollama, LM Studio, etc.

4

Test & Save

Test your API key to ensure it works, then save it to your account.

API Key Validated

Your API key is working correctly and ready to use for translations.

Where to Get API Keys

OpenAI

Get your API key from the OpenAI platform.

platform.openai.com → API Keys → Create new secret key

Anthropic

Generate an API key from the Anthropic Console.

console.anthropic.com → API Keys → Create Key

DeepL

Get your API key from DeepL Pro account.

deepl.com/pro-account → API tab → Authentication Key

OpenRouter

Create an API key from your OpenRouter dashboard.

openrouter.ai → Keys → Create Key

Choosing the Right Model

Different AI models offer various tradeoffs between speed, quality, and cost. Choose based on your project needs:

💎 Premium Models (Highest Quality)

  • • GPT-4o: OpenAI's flagship model, excellent for complex content
  • • Claude-3-5-Sonnet: Anthropic's best, great for nuanced translation
  • • Best for: Critical documents, creative content, technical material
  • • Cost: Higher per token, but superior quality

⚡ Balanced Models (Speed + Quality)

  • • GPT-4o-mini: Fast and cost-effective OpenAI option
  • • Claude-3-Haiku: Quick processing with good quality
  • • Best for: Standard documents, bulk processing
  • • Cost: Lower cost, excellent value for routine work

💡 Model Selection Tips

  • • Start with balanced models for testing, upgrade to premium for final work
  • • Use premium models for customer-facing content
  • • Consider model-specific strengths (GPT-4o for technical, Claude for creative)
  • • Monitor quality vs cost ratio in your usage statistics

Rate Limiting & System Reliability

Insurgent Ink includes intelligent rate limiting and reliability features to ensure smooth operation:

🛡️ Intelligent Rate Limiting

  • • Automatic detection: Recognizes API rate limits and adjusts processing speed
  • • Smart backoff: Uses exponential backoff with jitter to prevent overwhelming APIs
  • • Real-time monitoring: Tracks token usage, request limits, and reset times
  • • Provider-specific handling: Tailored retry logic for each AI provider

⚙️ Enhanced Reliability

  • • Queue management: Optimized concurrency to prevent rate limit errors
  • • Failure recovery: Intelligent retry mechanisms for temporary failures
  • • Load balancing: Distributes work across multiple API keys when available
  • • Error tracking: Detailed logging for troubleshooting and optimization

Custom API Configuration

Advanced users can configure custom API endpoints for self-hosted models and specialized services:

🔧 Supported Custom APIs

  • • Ollama: Local model hosting (http://localhost:11434)
  • • LM Studio: Local API server (http://localhost:1234)
  • • Text Generation WebUI: Self-hosted inference (custom port)
  • • OpenAI-compatible APIs: Any service following OpenAI format
  • • Enterprise endpoints: Private cloud deployments

⚙️ Configuration Options

  • • Custom headers: Authentication tokens, API versions, special parameters
  • • Model names: Specify exact model identifiers for your endpoint
  • • Timeout settings: Adjust for slower self-hosted models
  • • SSL options: Support for self-signed certificates in development

Security Best Practices

🔒 Keep Keys Secure

  • • Never share your API keys with others
  • • Use descriptive names to identify keys
  • • Regularly rotate your API keys
  • • Monitor usage in provider dashboards
  • • Enable 2FA on your AI provider accounts

💰 Cost Management

  • • Set usage limits in provider accounts
  • • Monitor monthly spending and usage patterns
  • • Start with lower-cost models for testing
  • • Remove unused keys to prevent accidental charges
  • • Use Insurgent Ink's cost tracking features

🔐 Custom API Security

  • • Use HTTPS endpoints when possible
  • • Secure your self-hosted models with authentication
  • • Restrict API access to known IP addresses
  • • Regularly update and patch self-hosted services