Content API v0.6.4

View as Markdown The page’s .md file llms.txt All pages, for AI tools Open in ChatGPT Ask questions about the page Open in Claude Ask questions about the page

The events a library publishes, with time, place, audiences, price and the series they belong to.

3 groups · 4 operations · 4 paths · 48 schemas Generated from content_v0_6_4.yaml · OpenAPI 3.0.0 Download the OpenAPI file

Implemented by: The library system — the API can also be implemented on its own
Called by: Services that show the library's programme — website, app, screens
Profile of Provider API: 4 of the 53 operations in Provider API

The Content API covers one area: the library’s events. An event carries its times, its location, its audiences, its price and the series it may belong to.

It has four operations: the events (GET /content/event), the events in a series (GET /content/event/series/{seriesId}), the content configuration and the version.

How to integrate

Authentication, base URL and the version parameter are the same as in the Provider API, and the specification declares the same two scopes as the Search API, read and write. Start with GetContentConfiguration (GET /configuration/content) — it tells you which UI languages the content is available in.

How it relates to the Provider API

The Content API is a profile of the Provider API: all four operations are also there, with the same operationId, method and path. It can be implemented on its own, so a system can offer its programme without the rest of the Provider API.

Shared across operations

These definitions are shared by the API’s operations. They are documented once here; an operation lists only what is specific to it, plus the codes it can return.

Authentication

BearerAuth · oauth2 · Flow: clientCredentials · Token URL: /authentication/oauth2/token

Parameters

version In query · Version · optional · used by 3 of 4 The version of Open Library the vendor expects to receive, if this version isn't supported by the provider an error code 600 (Unsupported Open Library API version) is returned.
ui_language In query · string · optional · used by 2 of 4 The UI language the provider will return the content in. All ui language codes should be on this list https://www.loc.gov/marc/languages/

Error responses

HttpCode400 Errors · used by 3 of 4 The list of errors.
HttpCode401Bearer No response body. · used by 3 of 4 Bearer token invalid, missing, or expired.
HttpCode404 No response body. · used by 1 of 4 Resource not found.