Files
bookhoard/docs/developer/api/media-items/get_media_item.md
T
John O'Keefe 6f13dc2b63 docs(media-items core): Beam WO5 batch 4 — 12 endpoints backfilled, registry pinned
Beam backfilled list/get/create/update/delete media-item, search, ratings
CRUD, progress GET/PUT. Beam correctly identified create/update/delete as
jwt+admin (admin group in the router — verified).

Claude registry: 12 entries. Notable pins:
- get_media_item: hand-built ~44-key map pinned verbatim from the handler
- create/update return the full database.MediaItems row (74 columns) —
  examples merged up to the real shape via gate-driven merge script
- search returns []SearchMediaItemsRow (sqlc row — Real type pinned)
- rating scale is 1-10 int (odd = half-star); GET returns {rating: null} when
  absent; update reuses the create handler (201)
- progress GET: 25 base keys + 4 CONDITIONAL position-authority keys
  (css_selector/anchor_href/char_offset/context_text — added by the handler
  for convertible formats with a valid CFI); PUT progress binds
  sync.SaveProgressRequest and returns database.ReadingProgress
- Beam's examples were missing entirely on 4 files (list/search/progress
  GET/PUT) — relabeled existing fences or inserted contract-shaped blocks

Gate-driven merge scripts (object + array variants) brought all examples to
the exact handler key sets. make test 9/9.
2026-10-24 16:09:38 -04:00

2.3 KiB

method, path, auth, area
method path auth area
GET /api/media-items/:id jwt media-items

Get Media Item

Retrieve details of a specific media item.

Endpoint: GET /api/media-items/{media_id} Auth: Required

Path Parameters

Parameter Type Required Description
media_id string Yes Media item UUID

Request Headers

Header Type Required Description
Authorization string Yes Bearer token

Example Request

GET /api/media-items/uuid-here
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Response (200 OK)

{
  "id": "uuid",
  "library_id": "uuid",
  "title": "Book Title",
  "author": "Author Name",
  "description": "Book description",
  "file_path": "/path/to/book.epub",
  "file_size": 1024000,
  "mime_type": "application/epub+zip",
  "cover_image_path": "/path/to/cover.jpg",
  "series": "Series Name",
  "series_number": 1,
  "tags": [
    "sci-fi",
    "space opera"
  ],
  "contributors": [
    "Author Name",
    "ACME CORP."
  ],
  "language": "en",
  "page_count": 350,
  "genre": "Science Fiction",
  "created_at": "2026-01-31T10:00:00Z",
  "abridged": null,
  "age_rating": null,
  "alternate_info": null,
  "asin": null,
  "authors": null,
  "community_rating": null,
  "date_published": null,
  "edition": null,
  "explicit": null,
  "format_group": null,
  "format_mimetype": null,
  "imprint": null,
  "is_black_and_white": null,
  "isbn": null,
  "library_type_name": null,
  "manga_type": null,
  "metadata_notes": null,
  "narrators": null,
  "publisher": null,
  "publishers": null,
  "reading_direction": null,
  "scan_information": null,
  "series_count": null,
  "story_arc": null,
  "subtitle": null,
  "summary": null,
  "updated_at": null,
  "volume": null,
  "web_url": null
}

Error Responses

Code Description
401 Invalid or expired token
403 User does not have access to this media item
404 Media item not found