Authentication

To use the illustrious API, you must obtain an API key and include it in the header when making requests. API keys can be easily created and managed in the 'My Page' section of the homepage. Users can obtain an API key by logging into their account and accessing the 'My Page' menu, and keys can be used immediately for API requests. This method effectively manages API access securely and tracks usage by user.

When making API requests, you must include the issued API key in the “x-illustrious-api-key” field of the HTTP request header. For example, an HTTP request might look like this:

curl -X POST 'https://api.v1.illustrious-xl.ai/api/text-to-image/generate' \
  --header 'Content-Type: application/json' \
  --header 'x-illustrious-api-key: YOUR_API_KEY' \
  --data '{
      "modelId" : 5,
      "steps" : 28,
      "width" : 256,
      "height" : 256,
      "prompt": "masterpiece, extremely aesthetic,\
       newest, very vibrant colors",\
      "negativePrompt": "worst quality, low quality, \
      lowers, low details, bad quality, poorly drawn, \ 
      bad anatomy, multiple views, bad hands, blurry, \ 
      artist sign, weibo username",
      "cfgScale" : 7.4,
      "seed" : -1,
      "samplerName" : "euler",
      "scheduler" : "normal"
  }'

In the example above, replace YOUR_API_KEY with your actual issued API key. This clear authentication method allows developers to easily integrate the API into their applications and reduces confusion during the API usage process

You should keep this key private for security and be careful not to share it with other users or expose it in client-side code. If you suspect your API key has been exposed, you can immediately reissue a key from your My Page.

Request frequency limits (Rate Limits) are applied by user and function to ensure stable operation of the API and smooth service use for all users. Rate Limits may be set differently depending on user level, subscription plan, and the frequency of use of specific API functions. Detailed information about specific Rate Limit policies will be provided through separate documentation. Rate Limits prevent API server overload and protect the system from malicious use.

If you exceed the rate limit, an error message will be returned along with a 429 status code. Please contact our support team for account upgrades or special quotas if you need a large number of requests.

All API requests and responses are encrypted and transmitted via HTTPS, using TLS version 1.2 or higher for data security. Developers should take appropriate security measures to protect API keys and generated content.

ComfyUI Custom Node

To get the most out of Illustrious API, we're rolling out official support for a dedicated Comfy node.

Pricing

Generate Image Pricing

The illustrious API adopts a transparent and predictable usage-based pricing model. With a pay-as-you-go approach, it can flexibly accommodate everything from small-scale projects to large enterprise solutions. Image generation models are priced per megapixel:

Text-Enhance Feature Pricing