---
title: "List characters"
method: GET
path: "/v1/characters"
tags: ["Characters"]
---

# List characters

`GET /v1/characters`

## Request

- Base URL: `https://api.tryleap.ai`
- URL: `https://api.tryleap.ai/v1/characters`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Your workspace's characters, newest first, the ones made in the studio included.

Needs an API key with the `generations:read` scope.

## Query parameters

- `limit` string: Maximum number of rows to return: 1 to 100; default 50.
- `cursor` string: Send next_cursor as cursor; omit it for the first page.

## Response `200`

A page of characters.

- CharacterList: Forward list envelope. Live lists are not snapshots; totals are not promised.
  - `object` 'list', required: The list object discriminator.
  - `url` string, required: The list's resource path, such as /v1/records.
  - `data` Character[], required: Resource objects in this page, in the requested order.
    - `id` string, required: The character's ID, `chr_...`. Pass it wherever a model or recipe takes an image file.
    - `object` 'character', required
    - `beta` true, required: This endpoint is in beta: its shape can change, or it can go away, without the 180-day notice stable endpoints get.
    - `name` string, required: The character's name.
    - `images` object[], required: Its pictures, first picture first.
      - `file` string, required: The picture's file, `file_...`.
      - `url` string, uri, required: A signed link to the picture, valid for 24 hours. Read the character again for a fresh one.
      - `width` integer, nullable, required
      - `height` integer, nullable, required
    - `created_at` string, date-time, required: When it was made.
    - `updated_at` string, date-time, required: When its name or pictures last changed.
  - `has_more` boolean, required: Whether another page is available using next_cursor.
  - `next_cursor` string, nullable, required: Opaque next_cursor from the previous page. It works only for the list and filters it came from.

## Other responses

- `400`: `invalid_parameter`, `conflicting_credentials`
- `401`: `authentication_required`
- `403`: `permission_denied`
- `429`: `rate_limit_exceeded`

---

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