Public API

Document Command API: New Commands

We have extended the Document Command API with two new commands, which are also available for Assistants.

Deprecate Menu Tool

The Menu Tool is deprecated and will be removed in release-2025-05. Please migrate your menus to data records, using the li-tree plugin and, if needed, the li-unique-id metadata plugin. For detailed instructions on setting up menus with data records, refer to our guide. We are here to assist with the migration as needed.

Document Command API: New Commands

We have extended the Document Command API with five new commands, which are also available for Assistants. Each command supports an optional oldValue parameter. When specified, the system verifies that the value being updated matches the provided oldValue. This prevents accidental overwrites that might occur due to changes made between reading a document and issuing the command. If the oldValue does not match, a conflict error is thrown.

Brand Conditions

Conditional components provide the ability to render a component in the delivery based on a brands or dateTime condition. The conditions are stored with the component data and can be input in the Livingdocs Editor.

API Versioning

We're introducing a new API Versioning Strategy that allows us to iterate on the API without breaking existing integrations.

Media Library: Serve Image

We've added a new public API endpoint:

Kordiam Rebranding: Remove Desknet endpoints in newer versions

The public API endpoints of the version 2025-05 do not support desknet in the path anymore.

Removal of Menu Tool

The Menu Tool has been removed, along with its public API endpoint. As a result, the following endpoints no longer exist:

Deprecation of `/project`, `/channelConfig` and `/channels/{channelHandle}` endpoints

The following endpoints are no longer available in newer api versions anymore:

Document Command API: New Publish Control Commands

We have extended the Document Command API with new publish control commands.

Deprecation of `renditions` endpoints and query parameters

The following endpoint is no longer available in newer api versions anymore:

Return objects with `results` array instead of directly returning arrays

Starting with /api/2026-01/* the Public API endpoints which previously returned an array now return an object containing a results property with this array. There can also be a total number of results and a cursor for pagination depending on whether or not the endpoint supports it. To improve the accuracy of the pagination the cursor can be passed back to the endpoints or functions using the after parameter, for example: /api/2026-01/publications/search?filters=${filters}&limit=10&after=${cursor}.

Revoke Note

Revoke State Conflict Errors

Revoking an already revoked media library entry will now throw a ConflictError, and return a 409 status for requests. Throwing an error is important to preserve the exising revoke note. It also matches the new unrevoke behaviour where calling unrevoke on an entry which is not revoked will throw an error.

Stricter Validation for Imported Documents

Documents imported via the Public API were previously validated too loosely, allowing imports with incorrect content structures. This could cause issues later when editing these documents in the Livingdocs Editor, where content validation is more strict.

Unrevoke

Preserve timestamps on Document Command API and Media Library Patch

A new optional preserveUpdatedAt boolean parameter has been added to the Document Command API and the Media Library patch endpoint.

Changelog

Please consult the API Versioning Strategy for more information on how we manage API versions. Bug fixes are not listed here.

Add Delivery Status

Composition API

Returns a Document Object with resolved includes and linked content.

Document Categories

Document Command API

Content Commands

Content commands modify the document content tree (the livingdoc). They operate on components and directives within the document structure.

Metadata Commands

Metadata commands modify the document title and metadata properties. These properties are defined by the document's content type configuration.

Publishing & Scheduling Commands

Publishing commands manage the document's publication lifecycle, including immediate publishing/unpublishing, embargoes, and scheduled publication actions.

Document Lists

Incoming Draft References

Returns Reference Objects pointing to this draft from other documents.

Latest Draft

Returns a Document Object.

Health

Documents

See the Document Object reference for the structure of the document payload.

Files

Images

Media Library Entries

See the Media Library Entry Object reference for the structure of the media library entry payload.

Videos

Get Entries

Returns a list of Media Library Entry Objects.

Get a Single Entry

Returns a Media Library Entry Object.

Incoming Media References

Returns Reference Objects pointing to this media entry from other media entries.

Patch an Entry

Updates and returns a Media Library Entry Object.

Incoming Publication References

Returns Reference Objects pointing to this media entry from publications.

Serve Image

Menus

Project Configuration

Incoming Media References

Returns Reference Objects pointing to this document from media library entries.

Incoming Publication References

Returns Reference Objects pointing to this document from other publications.

Latest Publication

Returns a Document Object.

Latest Publications

Returns a list of Document Objects.

Publication Events

Renditions

Search

Returns a list of Document Objects.

Search Filters

The Search Publications endpoint accepts a ?filters query parameter with a JSON-encoded query DSL for filtering documents by metadata and system fields.

Retresco re-enrich

Routing

Sitemaps

Authentication

Every request to the Public API requires a bearer token in the Authorization header. Tokens are scoped to a single project, so make sure you create the token in the correct project.

Common Errors

The API uses standard HTTP status codes. Errors return a JSON body with status, error, and error_details fields.

Introduction

The Livingdocs Public API is a REST API for integrating with Livingdocs. All endpoints use JSON, bearer token authentication, and date-based versioning in the URL path (e.g. /api/2026-01/). See Authentication and API Versioning for details.

Pagination

List endpoints return paginated results. The API uses two pagination patterns depending on the endpoint.

API Versioning

Livingdocs uses date-based API versioning. A new API version ships every odd month (January, March, May, July, September, November) alongside each Livingdocs release.

Document Object

A document publication returned by the Publications endpoints has this top-level shape:

Media Library Entry

A media library entry returned by the Media Library endpoints has this top-level shape:

References

Every Document Object includes a references array. Livingdocs automatically extracts these references from the document's metadata and content. They describe which resources (other documents, images, videos, files, lists, language groups) a document depends on.