Skip to content

List the chapters of an EPUB asset (reading order)

GET
/assets/{id}/epub/spine

Returns the ordered list of chapters from the default rendition’s spine. Each entry carries the chapter’s manifest id, a display label (NCX/TOC label when available, else the manifest id, else “Chapter N”), and the original href + media type for debugging. The frontend reader uses this to populate the table of contents + chapter picker.

id
required
string format: uuid

Ordered spine entries

Array<object>

One chapter entry from an EPUB’s spine (reading order). Returned by GET /assets/{id}/epub/spine; consumed by the frontend reader to render the TOC + chapter picker.

object
idx
required

Zero-based spine position; pass to /chapters/{idx}.

integer
label
required

Display label — NCX/TOC label, else manifest id, else “Chapter N”.

string
href
required

Original manifest href (debugging / federation parity).

string
media_type
required
string
Example
application/xhtml+xml

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Unexpected server error

object
error
required

Human-readable error summary

string
Example
the request could not be completed