---
title: "Get an image"
method: GET
path: "/images/{id}"
tags: ["Images"]
---

# Get an image

`GET /images/{id}`

## Request

- Base URL: `https://www.rainbrand.com/api/v1`
- URL: `https://www.rainbrand.com/api/v1/images/{id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://www.rainbrand.com/api/auth/oauth2/authorize`
    - Token URL: `https://www.rainbrand.com/api/auth/oauth2/token`

Retrieve an image and its current status.

## Path parameters

- `id` string, uuid, required: Image ID — works for generated, uploaded, and scraped images

## Query parameters

- `wait` union: Hold the connection until the resource reaches a terminal status
  - boolean
  - '0' | '1' | 'true' | 'false'
- `timeout` integer: Max seconds to wait (default 120, max 295)

## Response `200`

OK

- object
  - `data` object, required
    - `id` string, uuid, required
    - `source` 'generated' | 'uploaded' | 'scraped', required
    - `status` 'pending' | 'generating' | 'completed' | 'failed', nullable, required
    - `failureReason` 'content_safety' | 'rate_limited', nullable, required
    - `failure` object, nullable, required
      - `code` 'upstream_failed', required
      - `message` string, required
      - `retryable` boolean, required: True when a new attempt with the same request may succeed; if you sent an Idempotency-Key, use a new key for it. False when the request must change first, or when a video may still be finishing and already billed.
      - `providerMessage` string, nullable, required: The provider's explanation of why it rejected the request, with links and secrets removed. Null when the provider gave none, or when the failure concerns Rainbrand's own account or a provider-side error. Its wording can change.
    - `prompt` string, nullable, required
    - `description` string, nullable, required
    - `imageUrl` string, nullable, required
    - `aspectRatio` '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '16:9' | '21:9', nullable, required
    - `width` number, nullable, required
    - `height` number, nullable, required
    - `actionType` 'generation' | 'edit' | 'resize' | 'variant' | 'recreate' | 'remove-background' | 'vectorize', nullable, required
    - `variantGroupId` string, uuid, nullable, required
    - `workspaceId` string, nullable, required
    - `workspaceName` string, required
    - `createdAt` string, date-time, required

## Other responses

- `401`: 401
- `403`: 403
- `404`: 404
- `429`: 429

---

[API](https://skmtc.dev/rainbrand/apis/rainbrand-api.md) - [All operations](https://skmtc.dev/rainbrand/apis/rainbrand-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rainbrand/apis/rainbrand-api/revisions/012b8e9da4df?raw)