generate

Generate with Ideogram 4.0 asynchronously

Changed on

Accepts an Ideogram 4.0 generation request for asynchronous processing and returns immediately with a generation_id. Poll GET /v1/generations/{generation_id} to retrieve the result. If a webhook_url is supplied, the generated images are additionally POSTed to it once ready, in a payload that mirrors the synchronous response with an added generation_id for correlation.

See Webhooks for the delivery payload and how to verify webhook signatures.

post/v1/ideogram-v4/async/generate

Request

  • Base URL: https://api.ideogram.ai
  • URL: https://api.ideogram.ai/v1/ideogram-v4/async/generate
  • Auth: API key in header Api-Key

Query parameters

webhook_urlstring uri

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

Response

Request accepted for asynchronous delivery.

generation_idstring required

URL-safe base64 ID of the accepted generation. Matches the generation_id field delivered in the webhook payload, and the generation_id accepted by the generation polling endpoint.

Changes

  • de120c38c7a2Revision changes
    • warning

      deleted the header request parameter Api-Key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • 3125bb1c38a6Revision changes
    • info

      api operation id post_generate_image_v4_async removed and replaced with generate_post_generate_image_v4_async