---
title: "Get Illustration"
method: GET
path: "/api/v1/gems/{gem_id}/illustration"
tags: ["Gemstones"]
---

# Get Illustration

`GET /api/v1/gems/{gem_id}/illustration`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/gems/{gem_id}/illustration`
- Auth: none declared

## Path parameters

- `gem_id` integer, required

## Query parameters

- `kind` 'breakdown' | 'studio'

## Headers

- `authorization` string, nullable

## Response `200`

Successful Response

- IllustrationResponse: Explore Your Piece state for one piece and kind [LNK-ILLUS]. kind: breakdown (exploded view, inline in the section) or studio (the assembled piece on white, the result hero). auto: the client should start generation itself on not_generated / outdated, without a tap. `reason` is a stable code: unavailable, unsupported_category, no_main_stone, photo_insufficient, precheck_unavailable, review_failed, provider_error, storage_error, timeout, interrupted, attempt_limit. Image URLs are set only when status is ready and are opaque to the client.
  - `gem_id` integer, required
  - `kind` 'breakdown' | 'studio'
  - `status` 'not_generated' | 'queued' | 'generating' | 'ready' | 'failed' | 'ineligible' | 'outdated', required
  - `auto` boolean
  - `reason` string, nullable
  - `illustration_id` integer, nullable
  - `image_url` string, nullable
  - `thumb_url` string, nullable
  - `share_url` string, nullable
  - `created_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable
  - `disclosure` string

## Other responses

- `422`: Validation Error

---

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