Audiobookshelf · JSON-LD Context

Audiobookshelf Context

JSON-LD context defining the semantic vocabulary for Audiobookshelf from Audiobookshelf.

74 Classes 103 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
audiobookshelf: https://audiobookshelf.org/schema#

Classes

PostApiAuthorizeResponse GetApiBackupsResponse PostApiBackupsResponse PostApiBackupsUploadRequest PostApiBackupsUploadResponse PostApiCacheItemsPurgeResponse PostApiFeedsResponse PostApiFeedsCollectionRequest PostApiFeedsCollectionResponse PostApiFeedsItemRequest PostApiFeedsItemResponse PostApiFeedsSeriesRequest PostApiFeedsSeriesResponse GetApiFilesystemResponse PostApiItemsBatchDeleteRequest PostApiItemsBatchGetRequest PostApiItemsBatchGetResponse PostApiItemsBatchQuickmatchRequest PostApiItemsBatchUpdateRequest PostApiItemsBatchUpdateResponse PostApiItemsLi8Gch9Ve09Orgn4Fdz8CoverResponse DeleteApiLibrariesResponse GetApiLibrariesResponse PatchApiLibrariesRequest PatchApiLibrariesResponse PostApiLibrariesRequest PostApiLibrariesResponse PostApiLibrariesOrderRequest PostApiLibrariesOrderResponse GetApiMeItemsInProgressResponse GetApiNotificationdataResponse GetApiNotificationsResponse PatchApiNotificationsRequest PostApiNotificationsRequest PostApiNotificationsResponse DeleteApiNotificationsIdResponse PostApiPodcastsRequest PostApiPodcastsFeedRequest PostApiPodcastsFeedResponse PostApiPodcastsOpmlRequest PostApiPodcastsOpmlResponse GetApiSearchAuthorsResponse GetApiSearchBooksResponse PostApiSearchBooksResponse GetApiSearchChaptersResponse GetApiSearchCoversResponse GetApiSearchPodcastResponse PostApiSessionLocalRequest PostApiSessionLocalAllRequest PostApiSessionLocalAllResponse GetApiSessionsResponse PatchApiSettingsRequest PatchApiSettingsResponse GetApiTagsResponse PostApiTagsRenameRequest PostApiTagsRenameResponse DeleteApiToolsItemResponse PostApiToolsItemRequest PostApiToolsItemResponse PostApiUploadRequest PostApiUploadResponse GetApiUsersResponse PostApiUsersRequest PostApiUsersResponse GetAuthOpenidResponse GetAuthOpenidMobileRedirectResponse GetHealthcheckResponse PostInitRequest PostInitResponse PostLoginResponse PostLogoutRequest PostLogoutResponse GetPingResponse GetStatusResponse

Properties

Property Type Container
backups list
file string
serverAddress string
slug string
directories list
libraryItemIds list
libraryItems list
options
id string
mediaPayload
success boolean
updates integer
cover string
libraries list
name string
folders list
displayOrder integer
icon string
provider string
settings
mediaType string
newOrder integer
recentEpisode
progressLastUpdate integer
events list
data.events list
appriseApiUrl string
maxFailedAttempts integer
maxNotificationQueue integer
libraryId string
eventName string
urls list
titleTemplate string
bodyTemplate string
enabled boolean
type string
appriseType string
notifications list
notificationDelay integer
folderId string
path string
media
rssFeed string
podcast
opmlText string
feeds list
asin string
description string
image string
title string
subtitle string
author string
publisher string
publishedYear string
genres list
isbn string
brandIntroDurationMs integer
brandOutroDurationMs integer
chapters list
isAccurate boolean
runtimeLengthMs integer
runtimeLengthSec integer
results list
array list
body
sessions list
total integer
numPages integer
itemsPerPage integer
userFilter string
serverSettings
tag string
newTag string
bitrate string
codec string
channels integer
series string
library string
folder string
files string
users list
username string
password string
mediaProgress list
bookmarks list
seriesHideFromContinueListening list
isActive boolean
isLocked boolean
lastSeen integer
createdAt integer
permissions
librariesAccessible list
itemTagsAccessible list
token string
newRoot
user
userDefaultLibraryId string
Source string
socketId string
isInit boolean
language string
ConfigPath string
MetadataPath string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://audiobookshelf.org/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "audiobookshelf": "https://audiobookshelf.org/schema#",
    "PostApiAuthorizeResponse": "audiobookshelf:PostApiAuthorizeResponse",
    "GetApiBackupsResponse": "audiobookshelf:GetApiBackupsResponse",
    "backups": {
      "@id": "audiobookshelf:backups",
      "@container": "@list"
    },
    "PostApiBackupsResponse": "audiobookshelf:PostApiBackupsResponse",
    "PostApiBackupsUploadRequest": "audiobookshelf:PostApiBackupsUploadRequest",
    "file": {
      "@id": "audiobookshelf:file",
      "@type": "xsd:string"
    },
    "PostApiBackupsUploadResponse": "audiobookshelf:PostApiBackupsUploadResponse",
    "PostApiCacheItemsPurgeResponse": "audiobookshelf:PostApiCacheItemsPurgeResponse",
    "PostApiFeedsResponse": "audiobookshelf:PostApiFeedsResponse",
    "PostApiFeedsCollectionRequest": "audiobookshelf:PostApiFeedsCollectionRequest",
    "serverAddress": {
      "@id": "audiobookshelf:serverAddress",
      "@type": "xsd:string"
    },
    "slug": {
      "@id": "audiobookshelf:slug",
      "@type": "xsd:string"
    },
    "PostApiFeedsCollectionResponse": "audiobookshelf:PostApiFeedsCollectionResponse",
    "PostApiFeedsItemRequest": "audiobookshelf:PostApiFeedsItemRequest",
    "PostApiFeedsItemResponse": "audiobookshelf:PostApiFeedsItemResponse",
    "PostApiFeedsSeriesRequest": "audiobookshelf:PostApiFeedsSeriesRequest",
    "PostApiFeedsSeriesResponse": "audiobookshelf:PostApiFeedsSeriesResponse",
    "GetApiFilesystemResponse": "audiobookshelf:GetApiFilesystemResponse",
    "directories": {
      "@id": "audiobookshelf:directories",
      "@container": "@list"
    },
    "PostApiItemsBatchDeleteRequest": "audiobookshelf:PostApiItemsBatchDeleteRequest",
    "libraryItemIds": {
      "@id": "audiobookshelf:libraryItemIds",
      "@container": "@list"
    },
    "PostApiItemsBatchGetRequest": "audiobookshelf:PostApiItemsBatchGetRequest",
    "PostApiItemsBatchGetResponse": "audiobookshelf:PostApiItemsBatchGetResponse",
    "libraryItems": {
      "@id": "audiobookshelf:libraryItems",
      "@container": "@list"
    },
    "PostApiItemsBatchQuickmatchRequest": "audiobookshelf:PostApiItemsBatchQuickmatchRequest",
    "options": {
      "@id": "audiobookshelf:options"
    },
    "PostApiItemsBatchUpdateRequest": "audiobookshelf:PostApiItemsBatchUpdateRequest",
    "id": {
      "@id": "audiobookshelf:id",
      "@type": "xsd:string"
    },
    "mediaPayload": {
      "@id": "audiobookshelf:mediaPayload"
    },
    "PostApiItemsBatchUpdateResponse": "audiobookshelf:PostApiItemsBatchUpdateResponse",
    "success": {
      "@id": "audiobookshelf:success",
      "@type": "xsd:boolean"
    },
    "updates": {
      "@id": "audiobookshelf:updates",
      "@type": "xsd:integer"
    },
    "PostApiItemsLi8Gch9Ve09Orgn4Fdz8CoverResponse": "audiobookshelf:PostApiItemsLi8Gch9Ve09Orgn4Fdz8CoverResponse",
    "cover": {
      "@id": "audiobookshelf:cover",
      "@type": "xsd:string"
    },
    "DeleteApiLibrariesResponse": "audiobookshelf:DeleteApiLibrariesResponse",
    "GetApiLibrariesResponse": "audiobookshelf:GetApiLibrariesResponse",
    "libraries": {
      "@id": "audiobookshelf:libraries",
      "@container": "@list"
    },
    "PatchApiLibrariesRequest": "audiobookshelf:PatchApiLibrariesRequest",
    "name": {
      "@id": "audiobookshelf:name",
      "@type": "xsd:string"
    },
    "folders": {
      "@id": "audiobookshelf:folders",
      "@container": "@list"
    },
    "displayOrder": {
      "@id": "audiobookshelf:displayOrder",
      "@type": "xsd:integer"
    },
    "icon": {
      "@id": "audiobookshelf:icon",
      "@type": "xsd:string"
    },
    "provider": {
      "@id": "audiobookshelf:provider",
      "@type": "xsd:string"
    },
    "settings": {
      "@id": "audiobookshelf:settings"
    },
    "PatchApiLibrariesResponse": "audiobookshelf:PatchApiLibrariesResponse",
    "PostApiLibrariesRequest": "audiobookshelf:PostApiLibrariesRequest",
    "mediaType": {
      "@id": "audiobookshelf:mediaType",
      "@type": "xsd:string"
    },
    "PostApiLibrariesResponse": "audiobookshelf:PostApiLibrariesResponse",
    "PostApiLibrariesOrderRequest": "audiobookshelf:PostApiLibrariesOrderRequest",
    "newOrder": {
      "@id": "audiobookshelf:newOrder",
      "@type": "xsd:integer"
    },
    "PostApiLibrariesOrderResponse": "audiobookshelf:PostApiLibrariesOrderResponse",
    "GetApiMeItemsInProgressResponse": "audiobookshelf:GetApiMeItemsInProgressResponse",
    "recentEpisode": {
      "@id": "audiobookshelf:recentEpisode"
    },
    "progressLastUpdate": {
      "@id": "audiobookshelf:progressLastUpdate",
      "@type": "xsd:integer"
    },
    "GetApiNotificationdataResponse": "audiobookshelf:GetApiNotificationdataResponse",
    "events": {
      "@id": "audiobookshelf:events",
      "@container": "@list"
    },
    "GetApiNotificationsResponse": "audiobookshelf:GetApiNotificationsResponse",
    "data.events": {
      "@id": "audiobookshelf:data.events",
      "@container": "@list"
    },
    "PatchApiNotificationsRequest": "audiobookshelf:PatchApiNotificationsRequest",
    "appriseApiUrl": {
      "@id": "audiobookshelf:appriseApiUrl",
      "@type": "xsd:string"
    },
    "maxFailedAttempts": {
      "@id": "audiobookshelf:maxFailedAttempts",
      "@type": "xsd:integer"
    },
    "maxNotificationQueue": {
      "@id": "audiobookshelf:maxNotificationQueue",
      "@type": "xsd:integer"
    },
    "PostApiNotificationsRequest": "audiobookshelf:PostApiNotificationsRequest",
    "libraryId": {
      "@id": "audiobookshelf:libraryId",
      "@type": "xsd:string"
    },
    "eventName": {
      "@id": "audiobookshelf:eventName",
      "@type": "xsd:string"
    },
    "urls": {
      "@id": "audiobookshelf:urls",
      "@container": "@list"
    },
    "titleTemplate": {
      "@id": "audiobookshelf:titleTemplate",
      "@type": "xsd:string"
    },
    "bodyTemplate": {
      "@id": "audiobookshelf:bodyTemplate",
      "@type": "xsd:string"
    },
    "enabled": {
      "@id": "audiobookshelf:enabled",
      "@type": "xsd:boolean"
    },
    "type": {
      "@id": "audiobookshelf:type",
      "@type": "xsd:string"
    },
    "PostApiNotificationsResponse": "audiobookshelf:PostApiNotificationsResponse",
    "appriseType": {
      "@id": "audiobookshelf:appriseType",
      "@type": "xsd:string"
    },
    "notifications": {
      "@id": "audiobookshelf:notifications",
      "@container": "@list"
    },
    "notificationDelay": {
      "@id": "audiobookshelf:notificationDelay",
      "@type": "xsd:integer"
    },
    "DeleteApiNotificationsIdResponse": "audiobookshelf:DeleteApiNotificationsIdResponse",
    "PostApiPodcastsRequest": "audiobookshelf:PostApiPodcastsRequest",
    "folderId": {
      "@id": "audiobookshelf:folderId",
      "@type": "xsd:string"
    },
    "path": {
      "@id": "audiobookshelf:path",
      "@type": "xsd:string"
    },
    "media": {
      "@id": "audiobookshelf:media"
    },
    "PostApiPodcastsFeedRequest": "audiobookshelf:PostApiPodcastsFeedRequest",
    "rssFeed": {
      "@id": "audiobookshelf:rssFeed",
      "@type": "xsd:string"
    },
    "PostApiPodcastsFeedResponse": "audiobookshelf:PostApiPodcastsFeedResponse",
    "podcast": {
      "@id": "audiobookshelf:podcast"
    },
    "PostApiPodcastsOpmlRequest": "audiobookshelf:PostApiPodcastsOpmlRequest",
    "opmlText": {
      "@id": "audiobookshelf:opmlText",
      "@type": "xsd:string"
    },
    "PostApiPodcastsOpmlResponse": "audiobookshelf:PostApiPodcastsOpmlResponse",
    "feeds": {
      "@id": "audiobookshelf:feeds",
      "@container": "@list"
    },
    "GetApiSearchAuthorsResponse": "audiobookshelf:GetApiSearchAuthorsResponse",
    "asin": {
      "@id": "audiobookshelf:asin",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "audiobookshelf:description",
      "@type": "xsd:string"
    },
    "image": {
      "@id": "audiobookshelf:image",
      "@type": "xsd:string"
    },
    "GetApiSearchBooksResponse": "audiobookshelf:GetApiSearchBooksResponse",
    "title": {
      "@id": "audiobookshelf:title",
      "@type": "xsd:string"
    },
    "subtitle": {
      "@id": "audiobookshelf:subtitle",
      "@type": "xsd:string"
    },
    "author": {
      "@id": "audiobookshelf:author",
      "@type": "xsd:string"
    },
    "publisher": {
      "@id": "audiobookshelf:publisher",
      "@type": "xsd:string"
    },
    "publishedYear": {
      "@id": "audiobookshelf:publishedYear",
      "@type": "xsd:string"
    },
    "genres": {
      "@id": "audiobookshelf:genres",
      "@container": "@list"
    },
    "isbn": {
      "@id": "audiobookshelf:isbn",
      "@type": "xsd:string"
    },
    "PostApiSearchBooksResponse": "audiobookshelf:PostApiSearchBooksResponse",
    "GetApiSearchChaptersResponse": "audiobookshelf:GetApiSearchChaptersResponse",
    "brandIntroDurationMs": {
      "@id": "audiobookshelf:brandIntroDurationMs",
      "@type": "xsd:integer"
    },
    "brandOutroDurationMs": {
      "@id": "audiobookshelf:brandOutroDurationMs",
      "@type": "xsd:integer"
    },
    "chapters": {
      "@id": "audiobookshelf:chapters",
      "@container": "@list"
    },
    "isAccurate": {
      "@id": "audiobookshelf:isAccurate",
      "@type": "xsd:boolean"
    },
    "runtimeLengthMs": {
      "@id": "audiobookshelf:runtimeLengthMs",
      "@type": "xsd:integer"
    },
    "runtimeLengthSec": {
      "@id": "audiobookshelf:runtimeLengthSec",
      "@type": "xsd:integer"
    },
    "GetApiSearchCoversResponse": "audiobookshelf:GetApiSearchCoversResponse",
    "results": {
      "@id": "audiobookshelf:results",
      "@container": "@list"
    },
    "GetApiSearchPodcastResponse": "audiobookshelf:GetApiSearchPodcastResponse",
    "array": {
      "@id": "audiobookshelf:array",
      "@container": "@list"
    },
    "PostApiSessionLocalRequest": "audiobookshelf:PostApiSessionLocalRequest",
    "body": {
      "@id": "audiobookshelf:body"
    },
    "PostApiSessionLocalAllRequest": "audiobookshelf:PostApiSessionLocalAllRequest",
    "sessions": {
      "@id": "audiobookshelf:sessions",
      "@container": "@list"
    },
    "PostApiSessionLocalAllResponse": "audiobookshelf:PostApiSessionLocalAllResponse",
    "GetApiSessionsResponse": "audiobookshelf:GetApiSessionsResponse",
    "total": {
      "@id": "audiobookshelf:total",
      "@type": "xsd:integer"
    },
    "numPages": {
      "@id": "audiobookshelf:numPages",
      "@type": "xsd:integer"
    },
    "itemsPerPage": {
      "@id": "audiobookshelf:itemsPerPage",
      "@type": "xsd:integer"
    },
    "userFilter": {
      "@id": "audiobookshelf:userFilter",
      "@type": "xsd:string"
    },
    "PatchApiSettingsRequest": "audiobookshelf:PatchApiSettingsRequest",
    "serverSettings": {
      "@id": "audiobookshelf:serverSettings"
    },
    "PatchApiSettingsResponse": "audiobookshelf:PatchApiSettingsResponse",
    "GetApiTagsResponse": "audiobookshelf:GetApiTagsResponse",
    "PostApiTagsRenameRequest": "audiobookshelf:PostApiTagsRenameRequest",
    "tag": {
      "@id": "audiobookshelf:tag",
      "@type": "xsd:string"
    },
    "newTag": {
      "@id": "audiobookshelf:newTag",
      "@type": "xsd:string"
    },
    "PostApiTagsRenameResponse": "audiobookshelf:PostApiTagsRenameResponse",
    "DeleteApiToolsItemResponse": "audiobookshelf:DeleteApiToolsItemResponse",
    "PostApiToolsItemRequest": "audiobookshelf:PostApiToolsItemRequest",
    "bitrate": {
      "@id": "audiobookshelf:bitrate",
      "@type": "xsd:string"
    },
    "codec": {
      "@id": "audiobookshelf:codec",
      "@type": "xsd:string"
    },
    "channels": {
      "@id": "audiobookshelf:channels",
      "@type": "xsd:integer"
    },
    "PostApiToolsItemResponse": "audiobookshelf:PostApiToolsItemResponse",
    "PostApiUploadRequest": "audiobookshelf:PostApiUploadRequest",
    "series": {
      "@id": "audiobookshelf:series",
      "@type": "xsd:string"
    },
    "library": {
      "@id": "audiobookshelf:library",
      "@type": "xsd:string"
    },
    "folder": {
      "@id": "audiobookshelf:folder",
      "@type": "xsd:string"
    },
    "files": {
      "@id": "audiobookshelf:files",
      "@type": "xsd:string"
    },
    "PostApiUploadResponse": "audiobookshelf:PostApiUploadResponse",
    "GetApiUsersResponse": "audiobookshelf:GetApiUsersResponse",
    "users": {
      "@id": "audiobookshelf:users",
      "@container": "@list"
    },
    "PostApiUsersRequest": "audiobookshelf:PostApiUsersRequest",
    "username": {
      "@id": "audiobookshelf:username",
      "@type": "xsd:string"
    },
    "password": {
      "@id": "audiobookshelf:password",
      "@type": "xsd:string"
    },
    "mediaProgress": {
      "@id": "audiobookshelf:mediaProgress",
      "@container": "@list"
    },
    "bookmarks": {
      "@id": "audiobookshelf:bookmarks",
      "@container": "@list"
    },
    "seriesHideFromContinueListening": {
      "@id": "audiobookshelf:seriesHideFromContinueListening",
      "@container": "@list"
    },
    "isActive": {
      "@id": "audiobookshelf:isActive",
      "@type": "xsd:boolean"
    },
    "isLocked": {
      "@id": "audiobookshelf:isLocked",
      "@type": "xsd:boolean"
    },
    "lastSeen": {
      "@id": "audiobookshelf:lastSeen",
      "@type": "xsd:integer"
    },
    "createdAt": {
      "@id": "audiobookshelf:createdAt",
      "@type": "xsd:integer"
    },
    "permissions": {
      "@id": "audiobookshelf:permissions"
    },
    "librariesAccessible": {
      "@id": "audiobookshelf:librariesAccessible",
      "@container": "@list"
    },
    "itemTagsAccessible": {
      "@id": "audiobookshelf:itemTagsAccessible",
      "@container": "@list"
    },
    "PostApiUsersResponse": "audiobookshelf:PostApiUsersResponse",
    "token": {
      "@id": "audiobookshelf:token",
      "@type": "xsd:string"
    },
    "GetAuthOpenidResponse": "audiobookshelf:GetAuthOpenidResponse",
    "GetAuthOpenidMobileRedirectResponse": "audiobookshelf:GetAuthOpenidMobileRedirectResponse",
    "GetHealthcheckResponse": "audiobookshelf:GetHealthcheckResponse",
    "PostInitRequest": "audiobookshelf:PostInitRequest",
    "newRoot": {
      "@id": "audiobookshelf:newRoot"
    },
    "PostInitResponse": "audiobookshelf:PostInitResponse",
    "PostLoginResponse": "audiobookshelf:PostLoginResponse",
    "user": {
      "@id": "audiobookshelf:user"
    },
    "userDefaultLibraryId": {
      "@id": "audiobookshelf:userDefaultLibraryId",
      "@type": "xsd:string"
    },
    "Source": {
      "@id": "audiobookshelf:Source",
      "@type": "xsd:string"
    },
    "PostLogoutRequest": "audiobookshelf:PostLogoutRequest",
    "socketId": {
      "@id": "audiobookshelf:socketId",
      "@type": "xsd:string"
    },
    "PostLogoutResponse": "audiobookshelf:PostLogoutResponse",
    "GetPingResponse": "audiobookshelf:GetPingResponse",
    "GetStatusResponse": "audiobookshelf:GetStatusResponse",
    "isInit": {
      "@id": "audiobookshelf:isInit",
      "@type": "xsd:boolean"
    },
    "language": {
      "@id": "audiobookshelf:language",
      "@type": "xsd:string"
    },
    "ConfigPath": {
      "@id": "audiobookshelf:ConfigPath",
      "@type": "xsd:string"
    },
    "MetadataPath": {
      "@id": "audiobookshelf:MetadataPath",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Audiobookshelf API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Audiobookshelf's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-28) from openapi/_ae-authored/audiobookshelf-openapi-generated.yml.",
  "dcterms:created": "2026-10-28",
  "dcterms:source": [
    "openapi/_ae-authored/audiobookshelf-openapi-generated.yml"
  ]
}