v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

generate

Poll a generation

Retrieves the current status of an asynchronous generation, and its results once complete. Use the generation_id returned by the async generation endpoint. While the generation is pending or has failed, the response contains only generation_id, status, and created; the response_type and data fields are present only once status is completed.

get/v1/generations/{generation_id}

Path parameters

generation_idstring required

URL-safe base64 ID of the generation returned by the async generation endpoint.

Response

Generation status retrieved successfully.

generation_idstring required

URL-safe base64 ID of the generation.

status'pending' | 'completed' | 'failed' required

Current status of the generation. pending: still in progress; the response contains only generation_id, status, and created. completed: finished successfully; the response also includes response_type and data. failed: generation did not succeed; the response contains only generation_id, status, and created.

createdstring date-time required

The time the generation was created.

response_type'url'

Present when status is completed; always "url" for this shape.

failure_reasonstring

A short machine-readable reason the generation failed, for example content_policy_violation. Present only when status is failed.

Example response

{
  "generation_id": "bzue-VZtSlSMAneIbfCo2A",
  "status": "completed",
  "created": "2000-01-23T04:56:07+00:00",
  "response_type": "url",
  "data": [
    {
      "prompt": "prompt",
      "resolution": "2048x2048",
      "seed": 12345,
      "is_image_safe": true,
      "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89"
    }
  ]
}