For the complete documentation index, see llms.txt. This page is also available as Markdown.
Playground
The Playground section of the API Dashboard sidebar (Generate, Remix, Remove background) lets you run real API requests from the browser — no code required. It's the quickest way to try an endpoint, see the exact cURL command for a request, and inspect the raw JSON response before writing your integration. Playground requests use your API key and consume API credits like any other API call.
Each Playground page starts with an API key field: paste an existing key or click New key to create one. The key is kept in memory only and must be re-entered after a page refresh. For full request and response schemas, see developer.ideogram.ai.
Generate
The Generate page builds a text-to-image request. Write your prompt in the Text prompt tab, then set the resolution, rendering speed, and whether to opt the request into post-generation copyright detection. Each form field is labeled with its API parameter name (for example resolution, rendering_speed), and the cURL request block below the form updates live as you change settings — copy it to reproduce the same request from your terminal.
The Generate form. The cURL block mirrors your current settings; click Generate to run the request.
Switch to the JSON prompt tab to describe the image as structured JSON instead of free text — useful for precise control over scene, subject, and style attributes. See JSON Prompting for how to structure these prompts.
The JSON prompt tab accepts a structured prompt in place of free text.
When the request completes, the Output panel on the right shows the generated image alongside the full JSON response — including the image URL, resolution, seed, and safety fields your integration will receive.
The Output panel: the generated image plus the raw JSON response.
Remix
The Remix page reworks an existing image with a prompt. Upload an initial image (PNG, JPEG, or WebP), describe the change in the Prompt field, and set the image weight — higher values stay closer to the original image, lower values give the prompt more influence. Resolution, rendering speed, and copyright detection work the same as on Generate.
The Remix form: upload an initial image, add a prompt, and balance the two with image weight.
For example, starting from this photo as the initial image:
The initial image uploaded in this example.
With the prompt "Restyle this image as a vibrant watercolor painting," the Output panel shows the remixed result and its JSON response, so you can compare it against the original and adjust the image weight or prompt.
The Remix result: the photo restyled as a watercolor painting, with the raw response alongside.
Remove background
The Remove background page takes a single image upload (PNG, JPEG, or WebP) and returns it with the background removed — there are no other parameters. The cURL block shows the equivalent command for your own scripts.
Remove background: upload an image and run — no other settings.
The Output panel shows the cut-out result on a transparent background, and the JSON response includes the URL for downloading it. Here the background of the turkey photo from the Remix example has been removed.
The result: the subject isolated from its background, with the raw response alongside.
