# Source: https://docs.ideogram.ai/plans-and-pricing/ideogram-api.md

# Ideogram API

The Ideogram API offers powerful image generation and editing capabilities for developers and businesses looking to integrate Ideogram into their applications.

Read our API Docs to learn more: <https://developer.ideogram.ai>

Review API pricing here: <https://about.ideogram.ai/api-pricing>

## Signup&#x20;

To set up or access the Ideogram API, you first need to log in to your [Ideogram user account](https://ideogram.ai/). If you don’t have an account, you can easily create one by following [these steps](https://docs.ideogram.ai/using-ideogram/getting-started/signup-and-registration).

{% hint style="warning" %}
**Note:** Ideogram user subscriptions and API accounts are separate, each with its own payment system. Please note that you must log in to your Ideogram user account (which can be a free account) to set up or access your API account.
{% endhint %}

Once logged in, click your **Profile icon**, located at the bottom of the left-side panel, to access the **Profile panel** and then select **API Beta**.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FpKOuWPhEQV2wVgGvzJZE%2FIdeogram%20%E2%80%93%20philozoff%20-%20Light%20Dark%402x.png?alt=media&#x26;token=18a8100b-2c51-43ee-89fb-6f8475c94228" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FijjHmsrlbGmn901dmtqf%2FIdeogram%20%E2%80%93%20philozoff%20-%20Light%20Dark%402x.png?alt=media&#x26;token=bcfb8456-f0a8-4489-b93a-1e5a6e667c05" alt="" width="272"></picture><figcaption></figcaption></figure>

You will need then need to accept the [Developer API Agreement and Policy](https://about.ideogram.ai/api-tos) to proceed.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FFhklauRSbOOcsVT1FMww%2FCleanShot%202024-09-03%20at%2009.08.10%402x.png?alt=media&#x26;token=f1b32de0-1d40-468f-a0f5-23a2ce76079e" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FNqKKsbxxvMnTdJ3vmqdU%2FCleanShot%202024-09-03%20at%2009.07.52%402x.png?alt=media&#x26;token=154e0451-1d34-4fee-babf-2ebdec7da226" alt="" width="563"></picture><figcaption><p>You need to accept the Developer API Agreement and Policy before continuing with the signup process.</p></figcaption></figure>

After accepting the agreement, you will be directed to the API dashboard. Select the "Manage Payment" button in the lower left corner to add your payment information, which will be linked and used to fund your API credit balance.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2Foz4tNLFh3SlFhfnoyjPa%2FCleanShot%202024-09-03%20at%2009.25.21%402x.png?alt=media&#x26;token=57a43ff1-e0c0-478d-b7fe-82d673c5b766" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FPbnGKbP05kFlDq62oVo5%2FCleanShot%202024-09-03%20at%2009.25.04%402x.png?alt=media&#x26;token=cd264005-941b-4ec4-b651-fcea9e734074" alt=""></picture><figcaption></figcaption></figure>

Next, choose whether you are using the API for personal or business purposes.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FcC6lWLl9eRaY9TIpqljZ%2FCleanShot%202024-09-03%20at%2010.40.39%402x.png?alt=media&#x26;token=eef13563-92d6-4b5c-a1e2-eda739686744" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FMCs8DBTq2R8qLmPeeLy5%2FCleanShot%202024-09-03%20at%2010.40.25%402x.png?alt=media&#x26;token=79df00b0-f849-4095-a2db-4f296d292f45" alt="" width="563"></picture><figcaption></figcaption></figure>

You will then be forwarded to the payment page, where you will need to provide all necessary payment information. You will only be charged when you create your first API key.

<figure><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FtydERQ4FMjjFKdT2w1p6%2FCleanShot%202024-09-03%20at%2010.59.40%402x.png?alt=media&#x26;token=d498c328-a22a-4e4b-ae3b-4dd483fbb3c8" alt=""><figcaption><p>Provide all payment information here. You will only be charged when you create your first API key.</p></figcaption></figure>

## Generating an API Key

{% hint style="danger" %}
**IMPORTANT**:\
• The full API key <mark style="color:red;">**will only be shown to you once**</mark>, at the time of its creation. You need to store it in a safe place immediately, as it will not be displayed again afterward.

• Generating the API key may take some time. Please <mark style="color:red;">**do not refresh or close the window**</mark> until the process is complete.
{% endhint %}

At this point, you will be ready to create your first API key, which will trigger an initial funding that will be added to your balance. As you use the API, funds will be deducted from your credit balance based on our [API pricing](https://about.ideogram.ai/api-pricing). Your balance will automatically top-up to a predetermined value when it drops below a certain threshold. In the example image below, the Top-up Balance is $20.00 and the Minimum Balance Threshold is $10.00.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2F7eBjqFOrDrG622QFTPYJ%2FCleanShot%202024-09-03%20at%2011.17.34%402x.png?alt=media&#x26;token=7105bee2-371e-4e0b-b92e-072e3aa7b965" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FBwAYCvHrkXeFtIAhLorD%2FCleanShot%202024-09-03%20at%2011.14.57%402x.png?alt=media&#x26;token=a714a663-19b3-44d8-a1e4-f3592e89ed6e" alt=""></picture><figcaption></figcaption></figure>

You can now click the "Create API key" button to generate your first API key, which will allow you to integrate Ideogram into your applications. You may create multiple API keys, and all  keys you generate will be billed under the same plan.

Once created, the keys will appear as partial keys, displaying only the first few characters as a security measure. They will appear as shown in the image below.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FdVcYlMPIwVKqEYEu6pX0%2FAPI%20Keys%20-%20Dark.png?alt=media&#x26;token=d8ce0b86-8b9e-4d3b-a9ef-a090fdc571a7" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FUUDoxRByuyuZDPRMrn2T%2FAPI%20Keys%20-%20Light.png?alt=media&#x26;token=5d80ad27-186a-4ded-8e74-e52f9730e120" alt=""></picture><figcaption><p>This is how generated API keys appear in the Manage API </p></figcaption></figure>

You can click "Manage payment", located near the bottom of the API management window, at any time to update your linked payment information or billing details.

## Adjusting the Top-Up Balance and Threshold

You can adjust the minimum balance that triggers an automatic top-up. Additionally, you can set the account balance level that you want your automatic top-up to bring you to. By default, the minimum balance threshold is $10 and the top-up balance is $20. To adjust these values, click the Edit button and enter your desired amounts in the respective fields. Then, click Save to confirm your changes.

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FM66YDxtqxd131MtgFy8s%2FCleanShot%202024-09-17%20at%2014.00.18%402x.png?alt=media&#x26;token=15e9b6e6-28fe-4158-8496-29fbb51537d0" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FWe6m9XRbRQZ6c1TPEiPa%2FCleanShot%202024-09-17%20at%2013.58.55%402x.png?alt=media&#x26;token=9badf1e5-f085-423d-bc91-eabbaff2297a" alt="" width="563"></picture><figcaption><p>Click on the Edit button to change the values.</p></figcaption></figure>

<figure><picture><source srcset="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2F1xN8V2MoVddeIum4nKuc%2FCleanShot%202024-09-17%20at%2014.14.14%402x.png?alt=media&#x26;token=e85a44f8-fd40-4af1-b25f-916fc267b4f4" media="(prefers-color-scheme: dark)"><img src="https://1799634369-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzjhNby3LLsIikYuvxAJP%2Fuploads%2FY6UQf1ggBcW5RlrxErVz%2FCleanShot%202024-09-17%20at%2014.13.32%402x.png?alt=media&#x26;token=dc79b207-d254-4f0a-85a0-cf7ae23cc557" alt="" width="563"></picture><figcaption><p>Click on the Save button to save your changes.</p></figcaption></figure>

After that modification, every time the balance dips to $5.00 or below, it will automatically top-up to the predetermined amount of $80.00.

{% hint style="info" %}
Note: The minimum balance threshold must be above $2.00 and the top up balance must be above $10.00.
{% endhint %}

## Useful Links

* API Docs: <https://developer.ideogram.ai>
* API Agreement and Policy (TOS): <https://ideogram.ai/api-tos>
* API Status: <https://status.ideogram.ai/>
* API Pricing: <https://ideogram.ai/features/api-pricing>