Files
bookhoard/docs/developer/api/book-matching/create_device_file_alias.md
T
john-okeefe de4f2ba7d8 docs(api): add universal progress tracking documentation
- get_universal_progress.md - GET /api/progress/:id
- update_universal_progress.md - POST /api/progress/:id
- get_progress_history.md - GET /api/progress/:id/history

Documents device-agnostic (universal) reading progress tracking
that works across all devices (Kobo, KOReader, etc.)
2026-02-08 12:38:14 -05:00

1.2 KiB

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",
  "file_name": "book.epub",
  "file_hash": "abc123...",
  "created_at": "2026-02-08T10:00:00Z"
}

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

Try It Out