---
title: "List saved characters and elements"
method: GET
path: "/characters"
---

# List saved characters and elements

`GET /characters`

## Request

- Base URL: `https://pixeldojo.ai/api/v1`
- URL: `https://pixeldojo.ai/api/v1/characters`
- Auth: HTTP bearer

The key owner's Character Studio library: characters, products, outfits, locations, objects (props) and styles, newest first. Write `@Name` in any generation prompt to use one: on models that take reference images, its photos are attached automatically.

## Query parameters

- `kind` 'character' | 'product' | 'outfit' | 'location' | 'object' | 'style' | 'element'
- `q` string
- `limit` integer

## Response `200`

Saved characters and elements

- object
  - `characters` object[]
    - `id` string
    - `kind` string
    - `name` string
    - `description` string, nullable
    - `image_urls` string[]
    - `mention` string: What to write in a prompt, e.g. @Mara.
  - `count` integer

## Other responses

- `401`: Unauthorized

---

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