---
title: "List the viewer's images to reuse as references"
method: GET
path: "/v1/studio/reference-images"
tags: ["Studio"]
---

# List the viewer's images to reuse as references

`GET /v1/studio/reference-images`

## Request

- Base URL: `https://api.lizzflix.xyz` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lizzflix.xyz/v1/studio/reference-images`
- Auth: none declared

Studio images (character and location images, start frames, uploads) and reference-library uploads, newest first, as one `ReferenceImage` shape with a `ref` handle. Owner only; seriesId, characterId and locationId must be the caller's (else 404). Pass `nextCursor` back as `cursor` for the next page.

## Query parameters

- `tab` 'series' | 'all' | 'uploads': series (needs seriesId; the default when seriesId is given), all (the default otherwise) or uploads.
- `seriesId` string
- `characterId` string
- `locationId` string
- `kind` string: Comma-separated kinds: character, location, start_frame, render_frame, upload, other.
- `q` string: Matches labels and character, location and series names.
- `sort` 'recent' | 'recently_used': recent (default, paged) or recently_used (at most 12, no cursor).
- `cursor` string
- `limit` string: Page size, 1-100 (default 40).

## Response `200`

One page of reference images

- ReferenceImagePage
  - `items` ReferenceImage[], required
    - `ref` string, required: Handle to send back as a reference: `asset:<id>` for a studio image, `library:<id>` for a library upload.
    - `id` string, required
    - `origin` 'media' | 'library', required
    - `kind` 'character' | 'location' | 'start_frame' | 'render_frame' | 'upload' | 'other', required
    - `source` 'generated' | 'uploaded' | 'imported' | 'frame', required
    - `label` string, required
    - `mimeType` string, required
    - `width` integer, nullable, required
    - `height` integer, nullable, required
    - `byteSize` integer, nullable, required
    - `thumbnailPath` string, required: Owner-only thumbnail (`/v1/...`; web prefixes `/api`). WebP when Cloudflare Images is enabled, else the original bytes.
    - `contentPath` string, nullable, required: Full image of a studio image; null for library items.
    - `contentUrl` string, nullable, required: One-hour signed link to a library item's bytes; null for studio images.
    - `seriesId` string, nullable, required
    - `seriesTitle` string, nullable, required
    - `characterId` string, nullable, required
    - `characterName` string, nullable, required
    - `locationId` string, nullable, required
    - `locationName` string, nullable, required
    - `episodeId` string, nullable, required
    - `sceneId` string, nullable, required
    - `isApproved` boolean, required
    - `modelKey` string, nullable, required
    - `createdAt` string, required
    - `lastReferencedAt` string, nullable, required
  - `nextCursor` string, nullable, required

## Other responses

- `400`: Invalid query
- `401`: Unauthorized
- `404`: seriesId, characterId or locationId is missing or not the caller's

---

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