For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /images/{id}

Poll this endpoint until status is completed or failed.

Poll an image generation until status is completed or failed. When complete, the response includes the image URL, dimensions, and savedMediaId for the workspace media library.

Get image generation status

get

Retrieves the current status of an image generation job. Poll this endpoint until status is "completed" or "failed".

Authorizations
X-API-KEYstringRequired

API key for authentication

Path parameters
idstringRequired

The unique image generation ID returned from the create endpoint

Example: abc123xyz
Responses
200

Image generation status retrieved successfully

application/json
imageGenerationIdstringRequired

Unique identifier for the image generation job

Example: abc123xyz
statusstring · enumRequired

Current status of the image generation job

Example: completedPossible values:
get/v1.0/images/{id}
GET /v1.0/images/{id} HTTP/1.1
Host: public-api.gamma.app
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "imageGenerationId": "abc123xyz",
  "status": "completed",
  "image": {
    "url": "https://cdn.gamma.app/zc87vhr30n8uf3n/generated-images/n3QeEJVjYVqvPMldFjcLO.png",
    "width": 1080,
    "height": 1080,
    "format": "png",
    "mimeType": "image/png",
    "transparency": false,
    "aspectRatioUsed": "1:1",
    "savedMediaId": "def456uvw"
  },
  "warnings": [
    {
      "code": "no_brand_theme_applied",
      "message": "No brand theme found; a standard theme was used."
    }
  ],
  "error": {
    "message": "Failed to generate content",
    "statusCode": 500
  },
  "credits": {
    "deducted": 10,
    "remaining": 490
  }
}

Poll every 5 seconds until status is completed or failed. Use image.savedMediaId with POST /images/media/{savedMediaId}/archive to remove the item from the media library without deleting the underlying file.

Last updated

Was this helpful?