---
title: "Retrieve a character"
method: GET
path: "/v1/characters/{id}"
tags: ["Characters"]
---

# Retrieve a character

`GET /v1/characters/{id}`

## Request

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

One character, with fresh links to its pictures.

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

## Path parameters

- `id` string, required: The character's ID, `chr_...`.

## Response `200`

The character.

- Character: A character your workspace keeps. Put its ID in a run's input in place of an image file, and the run gets its pictures and a description of its look, so it comes out the same every time.
  - `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.

## Other responses

- `400`: `conflicting_credentials`
- `401`: `authentication_required`
- `403`: `permission_denied`
- `404`: `resource_not_found`
- `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)