Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135137125.7 KB
mylibrary

Inserts a new annotation.

post/books/v1/mylibrary/annotations

Query parameters

annotationIdstring

The ID for the annotation to insert.

countrystring

ISO-3166-1 code to override the IP-based location.

showOnlySummaryInResponseboolean

Requests that only the summary of the specified layer be provided in the response.

sourcestring

String to identify the originator of this request.

Request body

layerIdstring

The layer this annotation is for.

afterSelectedTextstring

Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

updatedstring

Timestamp for the last time this annotation was modified.

createdstring

Timestamp for the created time of this annotation.

selectedTextstring

Excerpt from the volume.

beforeSelectedTextstring

Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

highlightStylestring

The highlight style for this annotation.

selfLinkstring

URL to this resource.

idstring

Id of this annotation, in the form of a GUID.

kindstring

Resource type.

volumeIdstring

The volume that this annotation belongs to.

pageIdsstring[]

Pages that this annotation spans.

datastring

User-created data for this annotation.

deletedboolean

Indicates that this annotation is deleted.

Response

Successful response