---
title: "Read the noun-imagery library."
method: GET
path: "/artifacts/{artifactId}/noun-imagery"
tags: ["Artifacts"]
---

# Read the noun-imagery library.

`GET /artifacts/{artifactId}/noun-imagery`

## Request

- Base URL: `https://docs.sleeperhit.studio/api/v1`
- URL: `https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/noun-imagery`
- Auth: HTTP bearer

Returns how spoken-noun images appear in the live read (`displayMode`: insets, replace_backdrop or off), how many lines name a depictable noun, and each noun's image and status (queued, ready, failed). Read-only. Scope: `artifact:read`.

## Response `200`

The noun-imagery library.

- TableReadNounImageryResponse
  - `artifactId` string, required
  - `displayMode` 'insets' | 'replace_backdrop' | 'off', required: How spoken-noun images appear: `insets` over the backdrop, `replace_backdrop`, or `off`. Set it with POST /artifacts/{artifactId}/theater `nounImagery`.
  - `annotatedLines` integer, required: Lines that name at least one depictable noun.
  - `counts` object, required
    - `ready` integer, required
    - `queued` integer, required
    - `failed` integer, required
  - `nouns` object[], required
    - `normalizedNoun` string, required: The noun's key (lowercase, no leading article): pass it as `noun.normalizedNoun` to draw it again.
    - `displayLabel` string, required
    - `status` 'queued' | 'ready' | 'failed', required
    - `imageUrl` string, nullable, required
    - `error` string, nullable, required
    - `lastGeneratedAt` string, nullable, required

## Other responses

- `401`: Missing, malformed, revoked, or expired API key.
- `403`: API key is valid but lacks the scope, is blocked by IP allowlist, or the account is disabled.
- `404`: The story artifact does not exist or is owned by another account.
- `409`: The artifact is not in a state where this operation is valid yet (e.g. requesting an MP4 render before the share link exists).
- `429`: Rate limit for this API key + IP + route family was exceeded.
- `500`: The API failed unexpectedly. Safe to retry with the same Idempotency-Key.

---

[API](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api.md) · [All operations](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/revisions/86e084144cef?raw)
