0 Fork 0

Files

T

John O'Keefe 25ef0d12ba docs(kobo,koreader,collections): Beam WO5 batch 6 — 12 endpoints

Kobo emulation + KOReader calibre-compatible surface backfilled with
device-token auth; collections reorder + update_rule created.

Claude registry: 12 entries. kobo/koreader emulation endpoints all bind
arbitrary protocol POST bodies (markup/bookmark/gettests/sync-from-server,
koreader progress/bookmarks) — registered as AnyJSONObject, not bodyless as
first drafted. Initialization returns the library sync payload, not the init
response.

Contract correction in update_rule.md: the route is SetRuleEnabled ({enabled}
required -> {collection_id, is_smart}); Beam's draft invented rule-field
updates. Reordered response/status: {item_ids} -> {status: reordered}.

make test 9/9.

2026-10-24 16:25:00 -04:00

1.6 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/sync/kobo/:token/sync-from-server	device-token	kobo

Sync From Server

Status: Coming Soon — Native Kobo sync is not yet supported on real devices; this endpoint is under active development and may change.

Push content and metadata to Kobo device.

Endpoint: POST /api/sync/kobo/:token/sync-from-server Auth: Required (Device authentication)

Device Authentication

This endpoint requires device authentication (not user JWT). Kobo devices authenticate using their device credentials and access tokens.

Request Body

Field	Type	Required	Description
book_ids	array of string	No	Array of ContentIDs to sync
full_sync	boolean	No	Whether to perform full sync (default: false)

Example Request

{
  "book_ids": ["content-id-1", "content-id-2"],
  "full_sync": false
}

Response (200 OK)

{
  "BookmarksSent": null,
  "BooksSynced": null,
  "HighlightsSent": null
}

Error Responses

Code	Description
401	Device authentication failed
404	Device not found

Notes

This endpoint pushes library content from the server to the Kobo device. It's called during sync operations to update the device's library catalog.

1.6 KiB Raw Blame History