---
title: "List images"
method: GET
path: "/images"
---

# List images

`GET /images`

## Request

- Base URL: `https://api.shortgenius.com/v1`
- URL: `https://api.shortgenius.com/v1/images`
- Auth: HTTP bearer

Get all the images you have generated.

## Query parameters

- `page` number: The page number to retrieve.
- `limit` number: The maximum number of items per page.
- `for_public` number: If 1, only public images are returned.
- `associatedProductId` string, nullable: Filter images by associated product ID.

## Response `200`

Successful response

- object
  - `images` Image[], required: A list of generated images.
    - `id` string, uuid, required
    - `url` string, nullable, required
    - `associatedProductId` string, nullable
    - `type` 'GeneratedImage' | 'GeneratedImagePreset', required
    - `state` 'pending' | 'generating' | 'completed' | 'error' | 'request_smart_motion' | 'placeholder', required
    - `created_at` string, required: Date and time (ISO 8601) when the media was created.
    - `updated_at` string, nullable: Date and time (ISO 8601) when the media was last updated.
    - `prompt` string, required
    - `is_nsfw` boolean, required
    - `aspect_ratio` '9:16' | '16:9' | '1:1', required: Aspect ratio of the generated image.
    - `image_style_id` string, uuid, nullable
  - `has_more` boolean, required: Indicates if more items are available.

## Other responses

- `400`: Invalid request

---

[API](https://skmtc.dev/shortgenius/apis/shortgenius-api.md) · [All operations](https://skmtc.dev/shortgenius/apis/shortgenius-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shortgenius/apis/shortgenius-api/revisions/532abda8ff32?raw)