Skip to content
DocumentationAPI Reference

Audiobooks

Get an Audiobook
AudiobookRetrieveResponse audiobooks().retrieve(AudiobookRetrieveParamsparams = AudiobookRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/audiobooks/{id}
Get Several Audiobooks
AudiobookBulkRetrieveResponse audiobooks().bulkRetrieve(AudiobookBulkRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/audiobooks
Get Audiobook Chapters
AudiobookListChaptersPage audiobooks().listChapters(AudiobookListChaptersParamsparams = AudiobookListChaptersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/audiobooks/{id}/chapters
ModelsExpand Collapse
class SimplifiedChapterObject:
String id

The Spotify ID for the chapter.

DeprecatedOptional<String> audioPreviewUrl

A URL to a 30 second preview (MP3 format) of the chapter. null if not available.

long chapterNumber

The number of the chapter

String description

A description of the chapter. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

long durationMs

The chapter length in milliseconds.

boolean explicit

Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrlObject externalUrls

External URLs for this chapter.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> spotify

The Spotify URL for the object.

String href

A link to the Web API endpoint providing full details of the chapter.

String htmlDescription

A description of the chapter. This field may contain HTML tags.

List<ImageObject> images

The cover art for the chapter in various sizes, widest first.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

boolean isPlayable

True if the chapter is playable in the given market. Otherwise false.

List<String> languages

A list of the languages used in the chapter, identified by their ISO 639-1 code.

String name

The name of the chapter.

String releaseDate

The date the chapter was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

ReleaseDatePrecision releaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:
YEAR("year")
MONTH("month")
DAY("day")
JsonValue; type "episode"constant"episode"constant

The object type.

String uri

The Spotify URI for the chapter.

Optional<List<String>> availableMarkets

A list of the countries in which the chapter can be played, identified by their ISO 3166-1 alpha-2 code.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<ChapterRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> reason

The reason for the restriction. Supported values:

  • market - The content item is not available in the given market.
  • product - The content item is not available for the user's subscription type.
  • explicit - The content item is explicit and the user's account is set to not play explicit content.
  • payment_required - Payment is required to play the content item.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

Optional<ResumePointObject> resumePoint

The user's most recent position in the chapter. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.

Optional<Boolean> fullyPlayed

Whether or not the episode has been fully played by the user.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<Long> resumePositionMs

The user's most recent position in the episode in milliseconds.