Files
bookhoard/docs/developer/api/book-matching/create_device_file_alias.md
T
John O'Keefe 18084de7a6 docs(book-matching,collections): Beam batch 10 — 15 endpoints
WO3 sync internals resolved: the book-matching docs ARE the sync surface
(books/query, link-book, bulk/auto-link, unlinked-books, suggestions,
file-alias CRUD) + collections rule/test/bulk-assign/shelf-mapping
surface.

Dedupe resolved (Claude call): search_books.md declared
GET /api/books/match but its BODY documents POST /api/sync/books/query —
both routes exist and are distinct (query-param device protocol vs JSON
body plugin protocol). Repointed search_books.md frontmatter to the POST
route; get_book_matches.md keeps the GET.

Claude registry: 15 entries (one pre-existing link-book entry deduped).
Drift fixed by gate: auto-link request {confidence_threshold, limit} not
{device_id, threshold}; bulk-link link objects {unlinked_book_id,
media_item_id, confidence_score} not {device_id, book_id, ...};
responses {results,total,successful,failed}/{auto_linked,results}; added
missing example-responses (bare delete, remove-rule is_smart-after
semantics, bulk-assign per-book results). make test 9/9.
2026-10-24 17:59:27 -04:00

1.6 KiB

method, path, auth, area
method path auth area
POST /api/devices/:id/file-aliases jwt book-matching

Create Device File Alias

Create a new file alias for a device.

Endpoint: POST /api/devices/:id/file-aliases Auth: Required Content-Type: application/json

Path Parameters

Parameter Type Required Description
id string (UUID) Yes Device UUID

Request Body

Field Type Required Description
media_item_id string (UUID) Yes Media item UUID
file_name string Yes Name of the file
file_hash string No SHA256 hash of the file (optional)

Example Request

{
  "media_item_id": "550e8400-e29b-41d4-a716-446655440001",
  "file_name": "book.epub",
  "file_hash": "abc123..."
}

Response (201 Created)

{
  "id": "uuid",
  "device_id": "device-uuid",
  "media_item_id": "book-uuid",
  "confidence_score": null,
  "file_path": null,
  "file_sha256": null,
  "last_seen_at": null
}

Error Responses

Code Description
400 Invalid request data
401 Invalid or expired token
404 Device or media item not found
409 File alias already exists