> For the complete documentation index, see [llms.txt](https://docs.ideogram.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ideogram.ai/using-ideogram/ui-overview/pages-ui/api-dashboard.md).

# API Dashboard

The API Dashboard is the in-product area for setting up and managing Ideogram API access.

Use it to review API account status, create and manage API keys, track usage, and manage API billing. Endpoint details, schemas, examples, and model availability live in the public developer docs at [developer.ideogram.ai](https://developer.ideogram.ai). For first-time setup steps (accepting the Developer API Agreement, adding a payment method), see [Ideogram API](/plans-and-pricing/ideogram-api.md).

To open it, visit [ideogram.ai/manage-api](https://ideogram.ai/manage-api) or click **API Dashboard** in the left sidebar of the Ideogram app.

## Dashboard Home

The home screen shows your API credit balance at a glance — available, consumed, expired, and total issued credits — plus shortcuts for creating an API key, opening the developer docs, tracking usage, and connecting the Ideogram MCP server to agent workflows.

The sidebar's **Manage** section is where account administration lives: Dashboard, API Keys, Usage, Billing, and Settings. The **Playground** section (Generate, Remix, Remove background) lets you try the API interactively, and **Build** links out to the documentation, service status, and API pricing.

<figure><img src="/files/6pq3FC47ukzVrQtkigRw" alt="API Dashboard home screen showing credit summary tiles and get-started shortcuts, with the Manage section of the sidebar highlighted"><figcaption><p>The API Dashboard home screen. Management pages live in the sidebar's <strong>Manage</strong> section.</p></figcaption></figure>

API accounts are separate from your regular Ideogram workspace. The switcher at the top of the sidebar selects between your personal API account and any API teams.

## API Keys

API keys authenticate your requests to the Ideogram API. The API Keys page lists each key's partial value, label, creation date, and status.

To create a key:

1. Click **Create key**.

<figure><img src="/files/fBwb1L5Cfr40XnxPMoPQ" alt="API Keys page listing keys with partial value, label, date created, and status columns, with the Create key button highlighted"><figcaption><p>The API Keys list. Key values are only ever shown in part after creation.</p></figcaption></figure>

2. Optionally give the key a name, then click **Create**.

<figure><img src="/files/KvcJP3h9OVbyS9wOrnDa" alt="Create API key dialog with an optional name field and the Create button highlighted"><figcaption><p>Names help you tell keys apart later.</p></figcaption></figure>

3. **Copy the key immediately and store it securely.** The full key is shown only this once — afterwards, only the partial value is visible.

<figure><img src="/files/0BSKsb8ngaWVQvmVEndn" alt="Dialog confirming a new API key has been created, with the full key value obscured and the Copy key button highlighted"><figcaption><p>This is the only time the full key is displayed.</p></figcaption></figure>

To rename or revoke a key, click the **⋯** menu at the end of its row and choose **Edit label** or **Delete key**.

<figure><img src="/files/TvX22sAPKwGSZw2SbaJ3" alt="API key row menu open, showing the Edit label and Delete key options highlighted"><figcaption><p>Each key's row menu offers <strong>Edit label</strong> and <strong>Delete key</strong>.</p></figcaption></figure>

## Usage

The Usage page charts your recent API activity per endpoint and model version. Use the date-range selector to switch between the last 30, 60, or 90 days, and the **Show zero usage metrics** toggle to include endpoints you haven't called in the period.

<figure><img src="/files/SS4ofIWbDXKkTihiW2pU" alt="Usage page showing a per-endpoint API usage chart over time, with the date range selector highlighted"><figcaption><p>Per-endpoint usage over time, filterable by date range.</p></figcaption></figure>

## Billing

API billing is managed separately from Ideogram subscriptions and uses prepaid API credits. The Billing page has three tabs:

* **Credits** — your credit balances and top-up controls.
* **Billing information** — payment method, tax information, and a **Manage via Stripe** link to the billing portal.
* **Invoices** — invoice history, expandable to per-line-item detail.

### Adding credits

Click **Add credits**, then pick a preset amount or enter a custom one and confirm.

<figure><img src="/files/smXhdkvfNWvKK9cHgiHD" alt="Add credits dialog with preset amount options and the add button highlighted"><figcaption><p>Choose a preset or a custom amount.</p></figcaption></figure>

### Auto recharge

Auto recharge tops up your balance automatically: set a **minimum balance threshold** and a **top-up balance**, and when your credits fall below the threshold, Ideogram recharges to the top-up level. Enabling it can trigger an immediate charge to bring your balance up to the configured level — the confirmation dialog notes this before you save.

<figure><img src="/files/DyDO2e4aVhX79BVEL2KC" alt="Billing page Credits tab showing credit balance tiles and auto recharge settings, with the Add credits button and Auto recharge toggle highlighted"><figcaption><p>The Credits tab: balances, <strong>Add credits</strong>, and the <strong>Auto recharge</strong> toggle.</p></figcaption></figure>

### Credit expiry

API credits have an effective window — the **Ideogram API Usage** card on the Credits tab shows the effective date range for your issued credits, and any credits that lapse appear under **Total expired**. Check this card if your balance is lower than expected.

## Settings

Individual API accounts currently have no configurable settings; the Settings page applies to API team accounts where available.

## Playground

The sidebar's **Playground** section (Generate, Remix, Remove background) lets you run real API requests from the browser — no code required. See [Playground](/plans-and-pricing/ideogram-api/playground.md) for a full walkthrough.