---
title: "GET /api/v1/carousels/{carousel_id}"
method: GET
path: "/api/v1/carousels/{carousel_id}"
tags: ["Carousels"]
---

# GET /api/v1/carousels/{carousel_id}

`GET /api/v1/carousels/{carousel_id}`

## Request

- Base URL: `https://api.avatarfactory.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.avatarfactory.io/api/v1/carousels/{carousel_id}`
- Auth: one of:
  - API key in cookie `session`
  - HTTP bearer

## Path parameters

- `carousel_id` integer, required

## Response `200`

OK

- CarouselResponse
  - `admin` CarouselAdminResponse: Admin-only prompt inspector block (present only for admins).
    - `director` object, nullable
    - `slides` object
  - `aspect_ratio` string, required
  - `avatar_face` string, nullable
  - `avatar_face_focus` FaceFocusPoint: Where a square or circular crop of a face image has to look. Percentages of the FULL stored frame, so the SPA can hand them straight to a CSS ``object-position``. Written by ``app.modules.avatars.face_focus``; absent (``None``) when no face was detected, and the shared `AvatarFace` component then falls back to its upper-third default.
    - `x` number, required
    - `y` number, required
  - `avatar_id` integer, required
  - `avatar_name` string, nullable
  - `completed_at` string, nullable
  - `created_at` string, nullable
  - `error_message` string, nullable
  - `id` integer, required
  - `slide_count` integer, required
  - `slides` SlideResponse[]
    - `attempts` integer
    - `avatar_pose` string, nullable
    - `background_image` string, nullable
    - `body` string, nullable
    - `composited_image` string, nullable
    - `error_message` string, nullable
    - `headline` string, nullable
    - `id` integer, required
    - `layout_style` string, required
    - `role` string, required
    - `slide_index` integer, required
    - `status` string, required
  - `status` string, required
  - `template_key` string, required
  - `title` string, nullable
  - `topic` string, required

## Other responses

- `422`: Unprocessable Entity

---

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