Authentication - getimg.ai Docs

Every API request needs an API key in the Authorization header.

Authorization: Bearer $GETIMG_API_KEY

Get your API key

Create and manage API keys in the developer settings.

Use your key

import GetimgAI from "getimg-ai";

const client = new GetimgAI({
  apiKey: process.env.GETIMG_API_KEY, // default, can be omitted
});

const result = await client.images.generate({
  model: "seedream-5-lite",
  prompt: "A sunset over the ocean",
});

import os
from getimg import GetimgAI

client = GetimgAI(
    api_key=os.environ.get("GETIMG_API_KEY"),  # default, can be omitted
)

result = client.images.generate(
    model="seedream-5-lite",
    prompt="A sunset over the ocean",
)

curl -X POST https://api.getimg.ai/v2/images/generations \
  -H "Authorization: Bearer $GETIMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "seedream-5-lite", "prompt": "A sunset over the ocean"}'

Security best practices

Store API keys in environment variables, not source code.
Add .env files to .gitignore.
Revoke compromised API keys in developer settings and create replacements.
Use separate API keys for development and production.

Authentication errors

Missing, malformed, or invalid keys return 401 with error code invalid_api_key.

{
  "error": {
    "message": "Incorrect API key provided. You can manage your API keys at https://getimg.ai/app/developer/api-keys",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_api_key",
    "doc_url": "https://docs.getimg.ai/guides/authentication"
  }
}

V1 API keys do not work on this API. If you send one, the error message says so and points you to developer settings, where you can create a key for this API.

See Errors for error handling and retry guidance.