some lead
\nfirst paragraph
\nsecond
\nand third one. :)
"},{"handle":"mobile","content":{"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-1b8i1ksh20","identifier":"timeline.normal","component":"normal","content":{"caption":"my caption"},"styles":{"position":"left"}},{"id":"doc-1b8i1ksh30","identifier":"timeline.p","component":"p","content":{"text":"first paragraph"}},{"id":"doc-1b8i1me1d0","identifier":"timeline.p","component":"p","content":{"text":"second paragraph"}}],"design":{"name":"timeline","version":"1.1.0"}}},{"handle":"app","error":{"message":"Processing of Channel 'app' for document '1' failed. Detailed error message…"}}]}]}}}}}}},"/api/2026-03/document-lists/{id}":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Document Lists"],"operationId":"getDocumentListById","summary":"Get List by Id","description":"Get List by Id","parameters":[{"name":"id","description":"List Id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"reverse","description":"Pass `reverse=false` to get the list in the same order as you see it in the editor. (the default is reverse=true for backwards compatibility reasons)","in":"query","schema":{"type":"boolean"},"examples":{"doNotReverse":{"value":false}}},{"name":"fields","description":"Filters which (comma separated) document properties are included in the response. Defaults to `systemdata,metadata` also accepts `content` (no renditions).","in":"query","schema":{"type":"string"},"examples":{"withContent":{"value":"systemdata,metadata,content"}}},{"name":"limit","description":"A limit for how much documents to resolve for the requested list. Defaults to 100. Max. 100.","in":"query","schema":{"type":"integer","minimum":0,"maximum":100},"examples":{"default":{"value":100}}},{"name":"ignoreComponentConditions","description":"Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks.","in":"query","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"componentConditions","description":"JSON stringified object which contains the component conditions you would like to apply.","in":"query","schema":{"type":"string"},"examples":{"atASpecificTime":{"value":"{\"dateTime\":\"2024-02-14T17:25:10.391Z\"}"}}}],"responses":{"200":{"description":"ok"}}}},"/api/2026-03/document-lists":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Document Lists"],"operationId":"getAndFilterDocumentLists","description":"Get Lists","summary":"Get Lists","parameters":[{"name":"name","description":"Filters the result set and allows searching by list name.","in":"query","schema":{"type":"string"}},{"name":"limit","description":"A limit for how much documents to resolve for the requested list. Defaults to 10. Max. 100.","in":"query","schema":{"type":"integer","minimum":0,"maximum":100},"examples":{"default":{"value":10}}},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","in":"query","schema":{"type":"integer"},"examples":{"default":{"value":0}}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}},"examples":{"categories":{"value":{"results":[{"id":1,"name":"List one","createdAt":"2020-11-05T10:55:51.255Z","updatedAt":"2020-11-05T10:55:51.255Z"},{"id":2,"name":"List two","createdAt":"2020-11-05T11:09:16.561Z","updatedAt":"2020-11-05T11:09:16.561Z"},{"id":3,"name":"List three","createdAt":"2020-11-05T11:09:37.213Z","updatedAt":"2020-11-05T11:09:37.213Z"},{"id":4,"name":"List four","createdAt":"2020-11-05T11:08:53.765Z","updatedAt":"2020-11-05T11:08:53.765Z"}]}}}}}}}}},"/api/2026-03/mediaLibrary":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Media Library"],"operationId":"getMediaLibraryEntries","summary":"Get Media Library Entries","description":"Fetch multiple Media Library Entries by their `id` or `externalId`","parameters":[{"name":"ids","description":"Ids of a Media Library entries","in":"query","schema":{"type":"string"},"examples":{"multiple":{"value":"gxMMLV1fc-cm,f4jH1hyijDiF"}}},{"name":"externalIds","description":"Must be unique in combination with systemName","in":"query","schema":{"type":"string"},"examples":{"externalId":{"value":"6hedie82"}}},{"name":"systemName","description":"A string identifiyng the external system where the asset is imported from. It is recommended that you always set this value and it is required if you provide an externalId.","in":"query","schema":{"type":"string"},"examples":{"systemName":{"value":"externalSystem"}}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MediaLibraryEntry"}}}},"examples":{"success":{"value":{"results":[{"id":"asze63i9","version":1,"mediaType":"image","asset":{"url":"https://livingdocs.io/img.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"},{"id":"2er11b3i","version":1,"mediaType":"image","asset":{"url":"https://livingdocs.io/img2.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Other Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"}]}},"externalSystem":{"value":{"results":[{"id":"a77ei8nm","version":1,"systemName":"externalSystem","externalId":"ex-1","mediaType":"image","asset":{"url":"https://livingdocs.io/img.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"}]}}}}}}}}},"/api/2026-03/mediaLibrary/{id}":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Media Library"],"operationId":"getMediaLibraryEntryById","summary":"Get a Single Media Library Entry","description":"Fetch a Media Library Entries by its `id`","parameters":[{"name":"id","description":"Id of a Media Library entry","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaLibraryEntry"},"examples":{"success":{"value":{"id":"asze63i9","version":1,"mediaType":"image","asset":{"url":"https://livingdocs.io/img.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"}}}}}}}},"patch":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Media Library"],"operationId":"updateMediaLibraryEntry","summary":"Patch a Single Media Library Entry","description":"Patch a Media Library Entries by its `id`","parameters":[{"name":"id","description":"Id of a Media Library entry","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"number"},"preserveUpdatedAt":{"type":"boolean","description":"When true, the entry's updated_at timestamp is not modified by the patch operation."},"patches":{"type":"array","items":{"type":"object","properties":{"operation":{"type":"string"}}}}}},"examples":{"post":{"value":{"version":1,"patches":[{"operation":"setMetadataProperty","propertyName":"title","value":"updated title"},{"operation":"replaceAsset","value":{"key":"2021/11/23/my-new-file.png","url":"https: //example.com/my-new-file.png","size":10000,"width":1000,"height":800,"filename":"my-new-file.png","mimeType":"image/png"}},{"operation":"revokeAsset"},{"operation":"archive"},{"operation":"removeAsset","locale":"en"}]}}}}}},"responses":{"200":{"description":"ok"}}}},"/api/2026-03/projectConfig":{"get":{"security":[{"bearerAuth":["public-api:config:read"]}],"tags":["Project"],"summary":"Get Project Configuration","description":"Get Project Configuration","operationId":"getProjectConfig","responses":{"200":{"description":"ok"}}}},"/api/2026-03/sitemaps/entries":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Sitemaps"],"operationId":"getSitemapEntries","summary":"Get a Sitemap's Entries","description":"Get a Sitemap's Entries","parameters":[{"name":"baseUrl","description":"Base url of the delivery host. `?baseUrl=https://livingdocs.io/`","required":true,"in":"query","schema":{"type":"string"},"examples":{"baseURL":{"value":"https://livingdocs.io/"}}},{"name":"date","description":"Date for the specific month matching the schema from the sitemap index file. Example: `?date=2021-06` or `?date=2021-06.2`","schema":{"type":"string"},"in":"query","required":true},{"name":"contentTypes","description":"A comma-separated list of contentTypes to include in the sitemap. Example: `?contentTypes=regular,pages`","schema":{"type":"string"},"in":"query","examples":{"regularAndPagesContentTypes":{"value":"regular,pages"}}},{"name":"entriesPerPage","description":"Optional sitemap entry page size. Default 20000","schema":{"type":"string"},"in":"query","examples":{"default":{"value":"20000"}}}],"responses":{"200":{"description":"Sitemap","content":{"application/xml":{"examples":{"success":{"summary":"Sitemap example","externalValue":"https://livingdocsio.github.io/openapi/examples/sitemap-entries.xml"}}}}}}}},"/api/2026-03/sitemaps/index":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Sitemaps"],"operationId":"getSitemapIndex","summary":"Get a Sitemap's Index","description":"Get a Sitemap's Index","parameters":[{"name":"baseUrl","description":"Base url of the delivery host","schema":{"type":"string"},"in":"query","required":true},{"name":"contentTypes","description":"A comma-separated list of contentTypes to include in the sitemap. Example: `?contentTypes=regular,pages`","schema":{"type":"string"},"in":"query","examples":{"regularAndPagesContentTypes":{"value":"regular,pages"}}},{"name":"entriesPerPage","description":"Optional sitemap entry page size. Default 20000","schema":{"type":"string"},"in":"query","examples":{"default":{"value":"20000"}}}],"responses":{"200":{"description":"Sitemap","content":{"application/xml":{"examples":{"success":{"summary":"Sitemap example","externalValue":"https://livingdocsio.github.io/openapi/examples/sitemap-index.xml"}}}}}}}},"/api/2026-03/health":{"get":{"tags":["Health"],"operationId":"getApiStatus","summary":"Check API Status","description":"Check API Status","responses":{"200":{"description":"Status ok"}}}},"/api/2026-03/import/documents/status":{"get":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"getDocumentImportStatus","summary":"Check Import Status for Documents","description":"You can use this endpoint to check for the status and/or result of a document import.","parameters":[{"name":"id","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object"},"examples":{"success":{"value":{"finished":true,"state":"success","id":"25bzj8j","logs":[{"system_name":"integration-tests","external_id":"8Sv9Nu0d","document_id":1,"checksum":"123abc","project_id":3,"channel_id":2,"revision_id":1,"version":1,"id":1,"state":"imported"},{"state":"failed","reason":"Invalid metadata","external_id":"external-unique-id-345","title":"my second document"}]}}}}}}}}},"/api/2026-03/import/documents":{"post":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"getImportDocuments","summary":"Import Documents","description":"The document import does both create and update documents. The import remembers the `externalId` / `systemName` pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the `externalId` when you want to update documents). The document import in Livingdocs is asynchronous. You post a batch of documents that you want to import and get back an id with which you can query later to get your result.","requestBody":{"content":{"application/json":{"examples":{"example":{"value":{"systemName":"identifier-for-your-system","webhook":"https://my-domain.com/webhooks/document-import","context":{"myIdentifier":"some-identifier-sent-to-the-webhook"},"documents":[{"id":"123abc","title":"test import","contentType":"article","checksum":"xyz456","publicationDate":"1999-03-18T17:27:00.107Z","livingdoc":{"content":[{"identifier":"header","content":{"catchline":"imported catchline","title":"imported title","author":"imported author"}}],"design":{"name":"living-times","version":"1.0.1"}},"metadata":{"description":"foo"},"translations":[{"locale":"fr","metadata":{"description":"foo FR"}}],"flags":{"autoPublish":true}}]}}},"schema":{"type":"object","required":["systemName","documents"],"properties":{"systemName":{"type":"string","description":"Identifier for the system you are importing from, e.g. an archive"},"webhook":{"type":"string","format":"uri","description":"Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview."},"context":{"type":"object","description":"An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes."},"documents":{"description":"An array of documents to import. Each entry is an object.","type":"array","items":{"type":"object","required":["id","checksum","title","contentType","publicationDate","livingdoc","metadata"],"properties":{"id":{"type":"string","description":"a unique id (stored as externalId in Livingdocs) that identifies the document on your end, must be unique within your project."},"title":{"type":"string","description":"the title that the document should get in livingdocs"},"checksum":{"type":"string","description":"string to identify changes, e.g. an updated_at timestamp"},"contentType":{"type":"string","description":"the content type that the document should get in livingdocs"},"publicationDate":{"type":"string","format":"date-time","description":"sets the date of a publication. `autoPublish’ flag must be set for this to have an effect."},"livingdoc":{"type":"object","description":"A valid livingdoc declaration (content / design), must conform to your channel-config otherwise throws a validation error / release-2022-07: if no design is set it takes the design of the Project Config."},"metadata":{"type":"object","description":"An object of metadata, must conform to your channel-config otherwise throws a validation error"},"translations":{"type":"array","items":{"type":"object"},"description":"sets the date of a publication. `autoPublish` flag must be set for this to have an effect."},"flags":{"type":"object","description":"(optional) define additional import logic: \n`autoPublish`: publishes imported documents immediately \n`unpublish`: unpublishes imported documents immediately (release-2022-07)\n`onlyOverwriteUntouched`: only update documents that have no manual changes in livingdocs\n`neverOverwrite`: never update documents through the import API"}}}}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}},"examples":{"success":{"value":{"id":"25bzj8j"}}}}}},"429":{"description":"Usage Limit Exceeded","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"usageLimitExceeded":{"value":{"status":429,"error":"Usage Limit Exceeded","error_details":{"message":"Your plan does not allow you to upload more than 100 per day.\n You already uploaded 99 in the last 24 hours and are trying to upload 10 more.\n Please try again later."}}}}}}}}}},"/api/2026-03/import/files/status":{"get":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"getFileImportStatus","summary":"Check Import Status for Files","description":"You can use this endpoint to check for the status and/or result of a file import.","parameters":[{"name":"id","description":"The id that Livingdocs provided you for your prior call to `/import/files`","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object"},"examples":{"success":{"value":{"finished":true,"state":"success","id":"25bzj8j","files":[{"state":"success","mediaId":"jjiwhsf23kdk","systemName":"identifier-for-your-system","externalId":"external-unique-id-123"},{"state":"skipped","reason":"already exists","systemName":"identifier-for-your-system","externalId":"external-unique-id-234","mediaId":"jjiwhsf23kdg"},{"state":"failed","reason":"Could not upload file","systemName":"identifier-for-your-system","externalId":"external-unique-id-345"}]}},"inProgress":{"value":{"finished":false,"state":"started","id":"243kdc","startedAt":"2020-01-01 13:45:12"}},"failed":{"value":{"finished":true,"state":"failed","id":"098shjhv9"}}}}}}}}},"/api/2026-03/import/files":{"post":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"importFiles","summary":"Import Files","description":"The file import does both create and update files. The import remembers the `externalId` / `systemName` pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the `externalId` when you want to update files). The file import in Livingdocs is asynchronous. You post a batch of files that you want to import and get back an id with which you can query later to get your result.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["systemName","files"],"properties":{"systemName":{"type":"string","description":"Identifier for the system you are importing from, e.g. an archive"},"webhook":{"type":"string","format":"uri","description":"Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview."},"context":{"type":"object","description":"An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes."},"files":{"description":"An array of files to import. Each entry is an object with the following keys, all of which are required:","type":"array","items":{"type":"object","required":["id","url","fileName","metadata"],"properties":{"id":{"type":"string","description":"a unique id (stored as externalId in Livingdocs) that identifies the file on your end, must be unique within your project."},"url":{"type":"string","format":"uri","description":"a URL to a file"},"fileName":{"type":"string","description":"the title that the file should get in livingdocs"},"metadata":{"type":"object","description":"An object of metadata according to your project config"},"mediaType":{"type":"string","description":"the handle of one of the mediaTypes from your project configuration"}}}}}},"examples":{"import":{"value":{"systemName":"identifier-for-your-system","webhook":"https://my-domain.com/webhooks/file-import","context":{"myIdentifier":"some-identifier-sent-to-the-webhook"},"files":[{"url":"https://example.com/documents/annual-report-2023.pdf","id":"file-123abc","fileName":"Annual Report 2023","mediaType":"file","metadata":{"title":"Annual Report 2023","description":"Financial report for fiscal year 2023"}},{"url":"https://example.com/spreadsheets/sales-data-2023.xlsx","id":"file-456def","fileName":"Sales Data 2023","mediaType":"file","metadata":{"title":"Sales Data 2023","description":"Quarterly sales figures for 2023"}}]}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}},"examples":{"success":{"value":{"id":"25bzj8j"}}}}}},"429":{"description":"Usage Limit Exceeded","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"usageLimitExceeded":{"value":{"status":429,"error":"Usage Limit Exceeded","error_details":{"message":"Your plan does not allow you to upload more than 100 per day.\n You already uploaded 99 in the last 24 hours and are trying to upload 10 more.\n Please try again later."}}}}}}}}}},"/api/2026-03/import/images/status":{"get":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"getImageImportStatus","summary":"Check Import Status for Images","description":"You can use this endpoint to check for the status and/or result of a image import.","parameters":[{"name":"id","description":"The id that Livingdocs provided you for your prior call to `/import/images`","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object"},"examples":{"success":{"value":{"finished":true,"state":"success","id":"25bzj8j","images":[{"state":"success","externalId":"external-unique-id-123","systemName":"identifier-for-your-system","image":{"mediaId":"jjiwhsf23kdk","originalUrl":"https://livingdocs-images.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.jpeg","url":"https://livingdocs-images.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.jpeg?auto=format","width":2062,"height":1547,"mimeType":"image/jpeg","imageService":"imgix"}},{"state":"skipped","reason":"already exists","externalId":"external-unique-id-234","systemName":"identifier-for-your-system","image":{"mediaId":"jjiwhsf23wer","originalUrl":"https://livingdocs-images.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.jpeg","url":"https://livingdocs-images.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.jpeg?auto=format","width":2062,"height":1547,"mimeType":"image/jpeg","imageService":"imgix"}},{"state":"failed","reason":"Could not upload image","externalId":"external-unique-id-345","systemName":"identifier-for-your-system"}]}},"inProgress":{"value":{"finished":false,"state":"started","id":"243kdc","startedAt":"2020-01-01 13:45:12"}},"failed":{"value":{"finished":true,"state":"failed","id":"098shjhv9"}}}}}}}}},"/api/2026-03/import/images":{"post":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"importImage","summary":"Import Images","description":"The image import does both create and update images. The import remembers the `externalId` / `systemName` pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the `externalId` when you want to update images). The image import in Livingdocs is asynchronous. You post a batch of images that you want to import and get back an id with which you can query later to get your result.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["systemName","images"],"properties":{"systemName":{"type":"string","description":"Identifier for the system you are importing from, e.g. an archive"},"webhook":{"type":"string","format":"uri","description":"Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview."},"context":{"type":"object","description":"An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes."},"images":{"description":"An array of images to import. Each entry is an object with the following keys, all of which are required:","type":"array","items":{"type":"object","required":["id","url","fileName","metadata","mediaType"],"properties":{"id":{"type":"string","description":"a unique id (stored as externalId in Livingdocs) that identifies the document on your end, must be unique within your project."},"url":{"type":"string","format":"uri","description":"a URL to an image file, no data urls allowed, must be an image, allowed types: png, jpg, gif, svg"},"fileName":{"type":"string","description":"the title that the image should get in livingdocs"},"metadata":{"type":"object","description":"An object of metadata according to your project config"},"mediaType":{"type":"string","description":"the handle of one of the mediaTypes from your project configuration"}}}}}},"examples":{"import":{"value":{"systemName":"identifier-for-your-system","webhook":"https://my-domain.com/webhooks/image-import","context":{"myIdentifier":"some-identifier-sent-to-the-webhook"},"images":[{"url":"https://placekitten.com/800/600","id":"123abc","fileName":"cat","mediaType":"image","metadata":{"title":"kitten"}}]}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}},"examples":{"success":{"value":{"id":"25bzj8j"}}}}}},"429":{"description":"Usage Limit Exceeded","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"usageLimitExceeded":{"value":{"status":429,"error":"Usage Limit Exceeded","error_details":{"message":"Your plan does not allow you to upload more than 100 per day.\n You already uploaded 99 in the last 24 hours and are trying to upload 10 more.\n Please try again later."}}}}}}}}}},"/api/2026-03/import/mediaLibrary":{"post":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"importMediaLibraryEntries","summary":"Import Media Library Entries","description":"When you can upload images to the configured Media Library storage (e.g. AWS S3) yourself it is possible to create Media Library Entries through the API.\n\nThis has the advantage that the entris will be included in the response directly in contrast to the importImages endpoint where you only get a job id.\n\nYou can also provide a custom id to entries which helps with importing documents where images in the document should be referenced with the correct `mediaId` maybe even before creating the Media Library Entries themselves.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["mediaLibraryEntries"],"properties":{"mediaLibraryEntries":{"description":"An array of documents to import. Each entry is an object.","type":"array","items":{"type":"object","discriminator":{"propertyName":"mediaType"},"properties":{"mediaType":{"type":"string"}},"required":["mediaType"],"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-]{1,32}$","description":"Custom id (Allowed characters: a-z, A-Z, 0-9, and -). If omitted a random id will be generated."},"systemName":{"type":"string","description":"A string identifiyng the external system where the asset is imported from. It is recommended that you always set this value and it is required if you provide an externalId."},"externalId":{"type":"string","description":"Must be unique in combination with systemName."},"mediaType":{"type":"string","enum":["image"]},"asset":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string","format":"uri","pattern":"(http)?s?:?(\\/\\/[^\"']*\\.(?:png|jpg|jpeg|gif|png|svg|webp|mp4|mov))"},"size":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"filename":{"type":"string"},"mimeType":{"type":"string"}},"required":["key","url","size","width","height","mimeType","filename"]},"metadata":{"type":"object"},"translations":{"$ref":"#/components/schemas/MediaLibraryTranslations"}},"required":["mediaType","asset"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-]{1,32}$","description":"Custom id (Allowed characters: a-z, A-Z, 0-9, and -). If omitted a random id will be generated."},"systemName":{"type":"string","description":"A string identifiyng the external system where the asset is imported from. It is recommended that you always set this value and it is required if you provide an externalId."},"externalId":{"type":"string","description":"Must be unique in combination with systemName."},"mediaType":{"type":"string","enum":["file"]},"asset":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string","format":"uri","pattern":"(http)?s?:?(\\/\\/[^\"']*\\.*)"},"size":{"type":"number"},"filename":{"type":"string"},"mimeType":{"type":"string"}},"required":["key","url","size","mimeType","filename"]},"metadata":{"type":"object"},"translations":{"$ref":"#/components/schemas/MediaLibraryTranslations"}},"required":["mediaType","asset"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-]{1,32}$","description":"Custom id (Allowed characters: a-z, A-Z, 0-9, and -). If omitted a random id will be generated."},"systemName":{"type":"string","description":"A string identifiyng the external system where the asset is imported from. It is recommended that you always set this value and it is required if you provide an externalId."},"externalId":{"type":"string","description":"Must be unique in combination with systemName."},"mediaType":{"type":"string","enum":["video"]},"asset":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string","format":"uri","pattern":"(http)?s?:?(\\/\\/[^\"']*\\.*)"},"size":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"duration":{"type":"number"},"filename":{"type":"string"},"mimeType":{"type":"string"}},"required":["key","url","size","width","height","duration","mimeType","filename"]},"metadata":{"type":"object"},"translations":{"$ref":"#/components/schemas/MediaLibraryTranslations"}},"required":["mediaType","asset"]}]}}}},"examples":{"post":{"value":{"mediaLibraryEntries":[{"id":"custom-1","systemName":"externalSystem","externalId":"6hedie82","mediaType":"image","asset":{"key":"2022/08/25/d6068c02-ca85-421d-948d-ee0e2c15f372.jpeg","url":"https://livingdocs-images-development.s3.amazonaws.com/2022/08/25/d6068c02-ca85-421d-948d-ee0e2c15f372.jpeg","size":34910,"width":640,"height":427,"filename":"super-mario.jpeg","mimeType":"image/jpeg"},"metadata":{"title":"This is Super Mario!"},"translations":[{"asset":{"key":"2022/09/30/60984f90-c766-4546-9bc8-61f0832f9755.jpeg","url":"https://livingdocs-images-development.s3.amazonaws.com/2022/09/30/60984f90-c766-4546-9bc8-61f0832f9755.jpeg","size":188497,"width":640,"height":853,"filename":"jpg-super-mario-wall.jpg","mimeType":"image/jpeg"},"locale":"fr","metadata":{"title":"C'est Super Mario!"}}]},{"id":"custom-2","systemName":"externalSystem","externalId":"ahedie8x","mediaType":"file","asset":{"key":"2022/09/30/a1cb173d-e85f-498b-996e-5ce46058e9b9.pdf","url":"https://livingdocs-files-development.s3.amazonaws.com/2022/09/30/a1cb173d-e85f-498b-996e-5ce46058e9b9.pdf","size":3028,"filename":"a-simple-pdf.pdf","mimeType":"application/pdf"},"metadata":{"title":"A simple PDF"},"translations":[{"locale":"fr","metadata":{"title":"Un simple PDF"}}]},{"id":"custom-3","systemName":"externalSystem","externalId":"srfhediess","mediaType":"video","asset":{"key":"2022/09/30/2804fc3d-098d-4f8f-b25c-c6c15583d672.mp4","url":"https://livingdocs-videos-development.s3.amazonaws.com/2022/09/30/2804fc3d-098d-4f8f-b25c-c6c15583d672.mp4","size":8633462,"width":1280,"height":720,"duration":35.241667,"filename":"fire.mp4","mimeType":"video/mp4"},"metadata":{"title":"This is a fire"},"translations":[{"locale":"fr","metadata":{"title":"C'est un feu"}}]}]}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MediaLibraryEntry"}}}},"examples":{"success":{"value":{"results":[{"id":"asze63i9","version":1,"mediaType":"image","asset":{"url":"https://livingdocs.io/img.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"},{"id":"2er11b3i","version":1,"mediaType":"image","asset":{"url":"https://livingdocs.io/img2.jpg","mimeType":"image/jpeg","width":1600,"height":900,"size":21000},"metadata":{"title":"An Other Image"},"createdAt":"2020-12-27T09:19:00.928Z","updatedAt":"2020-12-27T09:19:00.928Z"}]}}}}}}}}},"/api/2026-03/import/videos/status":{"get":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"getVideoImportStatus","summary":"Check Import Status for Videos","description":"You can use this endpoint to check for the status and/or result of a video import.","parameters":[{"name":"id","description":"The id that Livingdocs provided you for your prior call to `/import/videos`","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object"},"examples":{"success":{"value":{"finished":true,"state":"success","id":"25bzj8j","videos":[{"state":"success","systemName":"identifier-for-your-system","externalId":"external-unique-id-123","video":{"mediaId":"jjiwhsf23kdk","originalUrl":"https://livingdocs-videos.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.mp4","mimeType":"video/mp4"}},{"state":"skipped","reason":"already exists","systemName":"identifier-for-your-system","externalId":"external-unique-id-234","video":{"mediaId":"jjiwhsf23wer","originalUrl":"https://livingdocs-videos.imgix.net/2019/11/21/a209790e-1549-46d9-b3c7-cefe28c7ea99.mp4","mimeType":"video/mp4"}},{"state":"failed","reason":"Could not upload video","systemName":"identifier-for-your-system","externalId":"external-unique-id-345"}]}},"inProgress":{"value":{"finished":false,"state":"started","id":"243kdc","startedAt":"2020-01-01 13:45:12"}},"failed":{"value":{"finished":true,"state":"failed","id":"098shjhv9"}}}}}}}}},"/api/2026-03/import/videos":{"post":{"security":[{"bearerAuth":["public-api:write"]}],"tags":["Imports"],"operationId":"importVideos","summary":"Import Videos","description":"The video import does both create and update videos. The import remembers the `externalId` / `systemName` pair and if an import matches an existing pair, it will update (Hint: consider how to rebuild the `externalId` when you want to update videos). The video import in Livingdocs is asynchronous. You post a batch of videos that you want to import and get back an id with which you can query later to get your result.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["systemName","videos"],"properties":{"systemName":{"type":"string","description":"Identifier for the system you are importing from, e.g. an archive"},"webhook":{"type":"string","format":"uri","description":"Endpoint at the importing system that gets notified by POST when import job is done. Notification contains the id of the import job, the state and an overview."},"context":{"type":"object","description":"An object that is passed as context in the body of the request to the webhook. Limited to 8192 Bytes."},"videos":{"description":"An array of videos to import. Each entry is an object with the following keys, all of which are required:","type":"array","items":{"type":"object","required":["id","url","fileName","metadata"],"properties":{"id":{"type":"string","description":"a unique id (stored as externalId in Livingdocs) that identifies the document on your end, must be unique within your project."},"url":{"type":"string","format":"uri","description":"a URL to an video file, no data urls allowed, must be an video, allowed types: (TODO)"},"fileName":{"type":"string","description":"the title that the video should get in livingdocs"},"metadata":{"type":"object","description":"An object of metadata according to your project config"}}}}}},"examples":{"importSingleVideo":{"value":[{"systemName":"identifier-for-your-system","webhook":"https://my-domain.com/webhooks/video-import","context":{"myIdentifier":"some-identifier-sent-to-the-webhook"},"videos":[{"url":"https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4","id":"123abc","fileName":"foo","metadata":{"title":"sample video","credit":"LC"}}]}]}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object"},"examples":{"success":{"value":{"id":"25bzj8j"}}}}}},"429":{"description":"Usage Limit Exceeded","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"usageLimitExceeded":{"value":{"status":429,"error":"Usage Limit Exceeded","error_details":{"message":"Your plan does not allow you to upload more than 100 per day.\n You already uploaded 99 in the last 24 hours and are trying to upload 10 more.\n Please try again later."}}}}}}}}}},"/api/2026-03/drafts/{documentId}/incomingDocumentReferences":{"get":{"security":[{"bearerAuth":["public-api:drafts:read"]}],"tags":["Drafts"],"operationId":"getIncomingDraftReferences","summary":"Get Incoming Draft References for a Document","description":"This endpoint is functionally equivalent to the incoming document references endpoint for publications. But with this draft endpoint you will receive references from unpublished documents as well as references from the current state of documents even if these latest updates to the document are not published yet.","parameters":[{"name":"documentId","schema":{"type":"integer"},"in":"path","required":true},{"name":"limit","description":"A limit for how much documents to retrieve. Defaults to 100. Max. 100.","schema":{"type":"integer"},"examples":{"default":{"value":100}},"in":"query"},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","schema":{"type":"integer"},"examples":{"default":{"value":0}},"in":"query"},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":"integer","references":{"type":"array","items":{"type":"object"}}}}}}},"examples":{"success":{"value":{"total":5,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"id":4,"references":[{"id":"1","type":"document","location":"include-directive","componentId":"doc-1euiflvoq0","serviceName":"editable-teaser","propertyName":"article","componentName":"teaser-include","directiveName":"teaser"}]},{"id":2,"references":[{"id":"1","type":"document","location":"include-directive","componentId":"doc-1eu6i7l880","serviceName":"editable-teaser","propertyName":"article","componentName":"teaser-include","directiveName":"teaser"}]}]}}}}}}}}},"/api/2026-03/documents/{documentId}/incomingMediaReferences":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Publications"],"operationId":"getIncomingMediaReferencesForDocument","summary":"Incoming Media References","description":"Get Incoming Media References for a Document. Added in: [release-2022-03](https://docs.livingdocs.io/operations/releases/release-2022-03/release-2022-03/)","parameters":[{"name":"documentId","schema":{"type":"integer"},"in":"path","required":true},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 100. Max. 100.","schema":{"type":"integer"},"examples":{"default":{"value":100}},"in":"query"},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","schema":{"type":"integer"},"examples":{"default":{"value":0}},"in":"query"},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":"integer","references":{"type":"array","items":{"type":"object"}}}}}}},"examples":{"success":{"value":{"total":2,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"id":"98sXCahM5PEk","references":[{"id":"3","type":"document","location":"metadata","propertyName":"documentLink"}]}]}}}}}}}}},"/api/2026-03/mediaLibrary/{mediaId}/incomingMediaReferences":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Media Library"],"operationId":"getIncomingMediaReferencesForMediaLibraryEntry","summary":"Get Incoming Media References for a Media Library Entry","description":"Added in: release-2022-03","parameters":[{"name":"mediaId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 100. Max. 100.","in":"query","schema":{"type":"number"},"examples":{"default":{"value":100}}},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","in":"query","schema":{"type":"number"},"examples":{"default":{"value":0}}},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":"integer","references":{"type":"array","items":{"type":"object"}}}}}}},"examples":{"success":{"value":{"total":2,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"id":"B1LPgANhJFpo","references":[{"id":"9fKagDCiN6sb","type":"image","location":"metadata","propertyName":"imageLink"}]}]}}}}}}}}},"/api/2026-03/documents/{documentId}/incomingDocumentReferences":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Publications"],"operationId":"getIncomingDocumentReferencesForDocument","summary":"Incoming Publication References","description":"Get Incoming Publication References for a Document","parameters":[{"name":"documentId","schema":{"type":"integer"},"in":"path","required":true},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 100. Max. 100.","schema":{"type":"integer"},"examples":{"default":{"value":100}},"in":"query"},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","schema":{"type":"integer"},"examples":{"default":{"value":0}},"in":"query"},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":"integer","references":{"type":"array","items":{"type":"object"}}}}}}},"examples":{"success":{"value":{"total":7,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"id":4,"references":[{"id":"1","type":"document","location":"include-directive","componentId":"doc-1euiflvoq0","serviceName":"editable-teaser","propertyName":"article","componentName":"teaser-include","directiveName":"teaser"}]},{"id":2,"references":[{"id":"1","type":"document","location":"include-directive","componentId":"doc-1eu6i7l880","serviceName":"editable-teaser","propertyName":"article","componentName":"teaser-include","directiveName":"teaser"}]}]}}}}}}}}},"/api/2026-03/mediaLibrary/{mediaId}/incomingDocumentReferences":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Media Library"],"operationId":"getIncomingDocumentReferencesForMediaLibraryEntry","summary":"Get Incoming Publication References for a Media Library Entry","description":"Added in: release-2022-03","parameters":[{"name":"mediaId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 100. Max. 100.","in":"query","schema":{"type":"number"},"examples":{"default":{"value":100}}},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination).","in":"query","schema":{"type":"number"},"examples":{"default":{"value":0}}},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":"integer","references":{"type":"array","items":{"type":"object"}}}}}}},"examples":{"success":{"value":{"total":3,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"id":2,"references":[{"id":"9fKagDCiN6sb","type":"image","location":"image-directive","componentId":"doc-1ev8345oj0","componentName":"image","directiveName":"image"},{"id":"9fKagDCiN6sb","type":"image","location":"metadata","propertyName":"teaserImage"}]},{"id":3,"references":[{"id":"9fKagDCiN6sb","type":"image","location":"image-directive","componentId":"doc-1euq8lq1o0","componentName":"image","directiveName":"image"},{"id":"9fKagDCiN6sb","type":"image","location":"metadata","propertyName":"teaserImage"}]}]}}}}}}}}},"/api/2026-03/documents/{documentId}/latestDraft":{"get":{"security":[{"bearerAuth":["public-api:write","public-api:drafts:read"]}],"tags":["Drafts"],"operationId":"getLatestDraftForDocument","summary":"Get Latest Draft","description":"**Added in:** [release-2022-03](https://docs.livingdocs.io/operations/releases/release-2022-03/release-2022-03/)\n\n**Required scope:** `public-api:write` `public-api:drafts:read`\n\nThis endpoint returns the most recent draft version of a document. A token with permission The response is a JSON object with 5 possible top-level properties: \n- systemdata \n- metadata \n- content \n- references","parameters":[{"name":"documentId","schema":{"type":"integer"},"in":"path","required":true},{"name":"ignoreComponentConditions","description":"Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks.","in":"query","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"componentConditions","description":"JSON stringified object which contains the component conditions you would like to apply.","in":"query","schema":{"type":"string"},"examples":{"atASpecificTime":{"value":"{\"dateTime\":\"2024-02-14T17:25:10.391Z\"}"}}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"systemdata":{"$ref":"#/components/schemas/Systemdata"},"metadata":{"$ref":"#/components/schemas/Metadata"},"content":{"$ref":"#/components/schemas/Content"},"references":{"$ref":"#/components/schemas/References"}}},"examples":{"success":{"value":{"systemdata":{"projectId":1,"channelId":1,"documentId":603,"contentType":"regular","documentType":"article","firstPublicationDate":"2022-02-22T16:33:42.836Z","updatedAt":"2022-02-22T16:33:42.836Z","design":{"name":"living-times","version":"1.0.4"}},"content":[{"id":"doc-1fsh4faeo0","identifier":"living-times.article-container","component":"article-container","position":"fixed","containers":{"main":[{"id":"doc-1fsh4faeo3","identifier":"living-times.paragraph","component":"paragraph","content":{"text":"First paragraph published."}},{"id":"doc-1fsh4g83l0","identifier":"living-times.paragraph","component":"paragraph","content":{"text":"Second paragraph unpublished."}}]}}],"references":[{"id":"KjqXSj2P1-L0","type":"language-group","location":"metadata","propertyName":"language"}],"metadata":{"language":{"label":"German","locale":"de","groupId":"KjqXSj2P1-L0"},"title":"Draft (Changed)"}}}}}}}}}},"/api/2026-03/documents/latestPublications":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Publications"],"operationId":"getLatestPublications","summary":"Latest Publications","description":"This endpoint is the list equivalent of the previous one. The response is an array of objects with 4 possible top-level properties: systemdata, metadata, content, references","parameters":[{"name":"fields","description":"Filters which (comma separated) properties are included in the response. Defaults to `systemdata,metadata,content`.","schema":{"type":"string"},"examples":{"example":{"value":"systemdata,metadata,content,references"}},"in":"query"},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 100. Max. 100.","schema":{"type":"integer","minimum":0,"maximum":100},"examples":{"default":{"value":100}},"in":"query"},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination)","schema":{"type":"integer"},"in":"query"},{"name":"reverse","description":"Order publications in ascending order instead of the default descending order. This is useful if you want to paginate using a time based filter.","schema":{"type":"boolean"},"in":"query"},{"name":"homepage","description":"Return only the document labeled as homepage in the current project.","schema":{"type":"boolean"},"in":"query"},{"name":"contentTypes","description":"Comma separated list of content types to use as filter.","schema":{"type":"string"},"examples":{"regularArticles":{"value":"regular"}},"in":"query"},{"name":"documentTypes","description":"Comma separated list of document types to use as filter.\nCan be one of `article`, `page`, `data-record`.","schema":{"type":"string"},"examples":{"documentTypes":{"value":"article,page,data-record"}},"in":"query"},{"name":"id","description":"Filter by one or multiple document ids.\n\nExample 1: `?id=12`\n\nExample 2: `?id=100,120,123` ","schema":{"type":"string"},"in":"query"},{"name":"id.gte","description":"Filter by document id range.\n\nSupported filters: `id.gte`, `id.gt`, `id.lte`, `id.lt`.\n\nThe id range filter is useful if you want to export a lot of documents. You can do many requests in parallel against the api, where you filter by the specific ranges.\n\nThis query is much more flexible than an offset-based filter and works with millions of documents.\n\nRequest 1: ?id.gt=0&id.lte=100\nRequest 2: ?id.gt=100&id.lte=200\nRequest 3: ?id.gt=200&id.lte=300","schema":{"type":"string"},"in":"query"},{"name":"id.gt","schema":{"type":"string"},"in":"query"},{"name":"id.lte","schema":{"type":"string"},"in":"query"},{"name":"id.lt","schema":{"type":"string"},"in":"query"},{"name":"publishedAt.gte","description":"Filter by publish date range.\nSupported filters: `publishedAt.gte`, `publishedAt.gt`, `publishedAt.lte`, `publishedAt.lt`.\n\nExample: To retrieve all publications since a specific timestamp, use `?reverse&publishedAt.gte=2021-05-01T00:00:00.000Z`","schema":{"type":"string","format":"date-time"},"examples":{"example":{"value":"2021-01-30T08:30:00Z"}},"in":"query"},{"name":"publishedAt.gt","schema":{"type":"string","format":"date-time"},"examples":{"example":{"value":"2021-01-30T08:30:00Z"}},"in":"query"},{"name":"publishedAt.lte","schema":{"type":"string","format":"date-time"},"examples":{"example":{"value":"2021-01-30T08:30:00Z"}},"in":"query"},{"name":"publishedAt.lt","schema":{"type":"string","format":"date-time"},"examples":{"example":{"value":"2021-01-30T08:30:00Z"}},"in":"query"},{"name":"ignoreComponentConditions","description":"Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks.","in":"query","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"componentConditions","description":"JSON stringified object which contains the component conditions you would like to apply.","in":"query","schema":{"type":"string"},"examples":{"atASpecificTime":{"value":"{\"dateTime\":\"2024-02-14T17:25:10.391Z\"}"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"systemdata":{"$ref":"#/components/schemas/Systemdata"},"metadata":{"$ref":"#/components/schemas/Metadata"},"content":{"$ref":"#/components/schemas/Content"},"references":{"$ref":"#/components/schemas/References"}}}}}},"examples":{"success":{"value":{"results":[{"systemdata":{"projectId":1,"channelId":1,"documentId":1,"contentType":"article","documentType":"article","publicationId":1,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2022-10-30T16:32:04.170Z","layout":"regular","design":{"name":"timeline","version":"1.1.0"}},"metadata":{"title":"a title","description":"some lead","dependencies":{}},"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-1b8i1ksh20","identifier":"timeline.normal","component":"normal","content":{"caption":"my caption"},"styles":{"position":"left"}},{"id":"doc-1b8i1ksh30","identifier":"timeline.p","component":"p","content":{"text":"first paragraph"}},{"id":"doc-1b8i1me1d0","identifier":"timeline.p","component":"p","content":{"text":"second paragraph"}}],"references":[{"id":"YbzTpusGyJtF","type":"language-group","location":"metadata","propertyName":"language"}]},{"systemdata":{"projectId":1,"channelId":1,"documentId":2,"contentType":"article","documentType":"article","publicationId":5,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2022-10-30T16:32:04.170Z","layout":"regular","design":{"name":"timeline","version":"1.1.0"}},"metadata":{"title":"another title","description":"some other lead","dependencies":{}},"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-1b8i1ksh20","identifier":"timeline.normal","component":"normal","content":{"caption":"my caption"},"styles":{"position":"left"}},{"id":"doc-1b8i1ksh30","identifier":"timeline.p","component":"p","content":{"text":"first paragraph"}},{"id":"doc-1b8i1me1d0","identifier":"timeline.p","component":"p","content":{"text":"second paragraph"}}],"references":[{"id":"YbzTpusGyJtF","type":"language-group","location":"metadata","propertyName":"language"}]}]}}}}}}}}},"/api/2026-03/mediaLibrary/serve-image/{key}":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Media Library"],"operationId":"mediaLibraryServeImage","summary":"Serve Image","description":"This endpoint delivers an image in its original dimensions, provided the asset remains valid (i.e., not revoked or marked as invalid).\nIt is designed to serve as a reliable source for image proxies or resizing services, ensuring only authorized and valid images are accessible.\n","parameters":[{"name":"key","in":"path","description":"The unique key of the image asset in the media library","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"error":{"type":"string"},"error_details":{"type":"object","properties":{"message":{"type":"string"}}}}},"examples":{"revokedOrInvalid":{"value":{"status":403,"error":"Forbidden","error_details":{"message":"The requested image is revoked or marked as invalid"}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number"},"error":{"type":"string"},"error_details":{"type":"object","properties":{"message":{"type":"string"}}}}},"examples":{"imageNotFound":{"value":{"status":404,"error":"Not Found","error_details":{"message":"No image found."}}}}}}}}}},"/api/2026-03/publicationEvents":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Publications"],"operationId":"getPublicationEvents","summary":"Publication Events","description":"Get Publication Events for the default channel","parameters":[{"name":"limit","description":"Number of events to return. Default: 100. Highest limit: 1000.","schema":{"type":"integer"},"examples":{"default":{"value":100}},"in":"query"},{"name":"reverse","description":"Returns the events in reverse order, starting at the biggest id.","schema":{"type":"boolean"},"examples":{"reverse":{"value":false}},"in":"query"},{"name":"contentTypes","description":"Comma separated list of content types to use as filter.","schema":{"type":"string"},"in":"query"},{"name":"documentTypes","description":"Comma separated list of document types to use as filter. \n\nCan be one of `article`, `page`, `data-record`.","schema":{"type":"string"},"in":"query"},{"name":"after","description":"**Deprecated**: Please use `id.gte` instead.\n\nReturn matching events after this event id.","schema":{"type":"integer"},"in":"query","deprecated":true},{"name":"id.gte","description":"Filter by event id range.\n\n**Supported filters**: `id.gte`, `id.gt`, `id.lte`, `id.lt`.\n\n**Example**: To retrieve all events since you’ve fetched the last entry, use `?limit=1000&id.gt=40000`","schema":{"type":"string"},"in":"query"},{"name":"id.gt","schema":{"type":"string"},"in":"query"},{"name":"id.lte","schema":{"type":"string"},"in":"query"},{"name":"id.lt","schema":{"type":"string"},"in":"query"},{"name":"createdAt.gte","description":"Filter by event date range.\n\n**Supported filters**: `createdAt.gte`, `createdAt.gt`, `createdAt.lte`, `createdAt.lt`.\n\n**Example**: To retrieve all events since a specific timestamp, use `?limit=1000&createdAt.gte=2021-05-01T00:00:00.000Z`","schema":{"type":"string"},"in":"query"},{"name":"createdAt.gt","schema":{"type":"string"},"in":"query"},{"name":"createdAt.lte","schema":{"type":"string"},"in":"query"},{"name":"createdAt.lt","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"projectId":{"type":"integer"},"channelId":{"type":"integer"},"documentId":{"type":"integer"},"documentType":{"type":"string"},"eventType":{"type":"string"},"publicationId":{"type":"integer"}}}}}},"examples":{"success":{"value":{"results":[{"id":910,"createdAt":"2016-12-27T09:19:00.928Z","projectId":30,"channelId":53,"documentId":7892,"documentType":"article","eventType":"publish","publicationId":1066},{"id":988,"createdAt":"2016-12-27T09:32:10.898Z","projectId":30,"channelId":53,"documentId":7892,"documentType":"article","eventType":"unpublish","publicationId":1100},{"id":990,"createdAt":"2016-12-27T09:33:05.010Z","projectId":30,"channelId":53,"documentId":8005,"documentType":"article","eventType":"publish","publicationId":1131},{"id":1011,"createdAt":"2016-12-27T09:33:31.517Z","projectId":30,"channelId":53,"documentId":7892,"documentType":"article","eventType":"update","publicationId":1394}]}}}}}}}}},"/api/2026-03/routing/resolve":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Routing"],"operationId":"resolveDocumentPath","summary":"Resolve a Path to a Document","description":"You need to activate the Categories / Routing Feature in the Project Config in order to resolve paths to your documents. Routing is a quite advanced topic and the examples only work with a default configuration. Find more [here](https://docs.livingdocs.io/guides/organisation/routing-system/).","parameters":[{"name":"path","description":"Path to the document.\n\n**Example 1:** A page with a category `/news` can be found with `?path=/news.html`.\n\n**Example 2:** A document with id 10, with category /news and a slug `hello` can be found with `?path=/magazin/hello-10.html`.","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"success":{"value":[{"type":"document","resource":{"id":173,"statusCode":200}}]}}}}},"301":{"description":"Moved Permanently","content":{"application/json":{"examples":{"movedPermanently":{"value":[{"type":"redirect","path":"/path/to/redirect","resource":{"statusCode":301}}]}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"notFound":{"value":{"status":404,"error":"Not Found"}}}}}}}}},"/api/2026-03/retresco/re-enrich":{"post":{"security":[{"bearerAuth":["retresco"]}],"tags":["Retresco"],"operationId":"retrescoReenrich","summary":"Retresco re-enrich Webhook","description":"This hook should be used on Retresco when enabling the re-enrich feature to trigger asynchronous document enrichment.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["doc_ids"],"properties":{"doc_ids":{"type":"array","items":{"oneOf":[{"type":"number"},{"type":"string"}]}}}},"examples":{"reEnrichWithIds":{"value":{"doc_ids":[1,2,3,4]}}}}}},"responses":{"200":{"description":"doc_ids list accepted to process"}}}},"/api/2026-03/publications/search":{"get":{"security":[{"bearerAuth":["public-api:read"]}],"tags":["Publications"],"operationId":"searchPublications","summary":"Search Publications","description":"Search Publications","parameters":[{"name":"search","description":"Search term to perform a full-text search with. For exact word matches use “, e.g. `search=“Ukulele”`","in":"query","schema":{"type":"string"},"examples":{"search":{"value":"some sentence to search"}}},{"name":"contentTypes","description":"Comma separated list of content-types for which documents should be found. Content types are concatenated with OR. Example: 'regular,author'","in":"query","schema":{"type":"string"},"examples":{"regularAndAuthor":{"value":"regular,author"}}},{"name":"categories","description":"Comma separated list of category ids for which documents should be found. Categories are concatenated with OR. Example: 'sport,fashion'","in":"query","schema":{"type":"string"},"examples":{"categories":{"value":"sport,fashion"}}},{"name":"languages","description":"Comma separated list of languages for which documents should be found. Languages are concatenated with OR. Example: 'en,de'","in":"query","schema":{"type":"string"},"examples":{"enAndDe":{"value":"en,de"}}},{"name":"languageGroupId","description":"A GroupId used to fetch all translations of a document Using the ?languages param a document in a specific language can be fetched. Example: `?languageGroupId=47?language=de`","in":"query","schema":{"type":"string"},"examples":{"languageGroupId":{"value":"1jfasfdu"}}},{"name":"filters","description":"A JSON string which follows the search filters query DSL.","in":"query","schema":{"type":"string"},"examples":{"termFilter":{"value":"[{\"key\":\"metadata.title\",\"term\":\"My Title\"}]"}}},{"name":"sort","description":"Comma separated list of sort properties. Any of the filter fields can be used, and also sortDate, which can be defined using the publication index config, or will be the Visible Publication Date. Most metadata properties can be used to sort, but not those indexed as 'text' or 'boolean'. The sort order can be reversed by prefixing the property with a `-`. Documents which don't have an indexed value will appear at the end of the results.","in":"query","schema":{"type":"string"},"examples":{"sortDate":{"value":"sortDate"},"descendingDocumentId":{"value":"-documentId"}}},{"name":"fields","description":"Filters which (comma separated) properties are included in the response. Defaults to `systemdata,metadata,content` (no renditions). Use `id` if you only want to retrieve the ids of the published documents. Useful (and faster) if you are fully synchronizing your frontend with the publication events.","in":"query","schema":{"type":"string"},"examples":{"default":{"value":"systemdata,metadata,content"}}},{"name":"limit","description":"A limit for how much published documents to retrieve. Defaults to 10. Max. 100.","in":"query","schema":{"type":"integer","minimum":0,"maximum":100},"examples":{"default":{"value":10}}},{"name":"offset","description":"An offset into the query. Useful when getting more than 100 results (pagination)","in":"query","schema":{"type":"integer"},"examples":{"default":{"value":0}}},{"name":"?after","description":"The `cursor` provided in the response can be passed back for pagination instead of using `offset`.","schema":{"type":"string"},"examples":{"cursor":{"value":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19"}},"in":"query"},{"name":"ignoreComponentConditions","description":"Provides a way to opt out of component filtering and return all content regardless of whether each component passes the conditional checks.","in":"query","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"componentConditions","description":"JSON stringified object which contains the component conditions you would like to apply.","in":"query","schema":{"type":"string"},"examples":{"atASpecificTime":{"value":"{\"dateTime\":\"2024-02-14T17:25:10.391Z\"}"}}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"cursor":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"systemdata":{"$ref":"#/components/schemas/Systemdata"},"metadata":{"$ref":"#/components/schemas/Metadata"},"content":{"$ref":"#/components/schemas/Content"},"references":{"$ref":"#/components/schemas/References"}}}}}},"examples":{"success":{"value":{"total":3,"cursor":"eyJhIjpbIjE3NjUyNjIxODYuMjgyIiw2NCw2NF19","results":[{"systemdata":{"projectId":1,"channelId":1,"documentId":1,"contentType":"article","documentType":"article","publicationId":1,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2022-10-30T16:32:04.170Z","layout":"regular","design":{"name":"timeline","version":"1.1.0"}},"metadata":{"title":"a title","description":"some lead","dependencies":{}},"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-1b8i1ksh20","identifier":"timeline.normal","component":"normal","content":{"caption":"my caption"},"styles":{"position":"left"}},{"id":"doc-1b8i1ksh30","identifier":"timeline.p","component":"p","content":{"text":"first paragraph"}},{"id":"doc-1b8i1me1d0","identifier":"timeline.p","component":"p","content":{"text":"second paragraph"}}],"references":[{"id":"YbzTpusGyJtF","type":"language-group","location":"metadata","propertyName":"language"}]},{"systemdata":{"projectId":1,"channelId":1,"documentId":2,"contentType":"article","documentType":"article","publicationId":5,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2022-10-30T16:32:04.170Z","layout":"regular","design":{"name":"timeline","version":"1.1.0"}},"metadata":{"title":"another title","description":"some other lead","dependencies":{}},"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-1b8i1ksh20","identifier":"timeline.normal","component":"normal","content":{"caption":"my caption"},"styles":{"position":"left"}},{"id":"doc-1b8i1ksh30","identifier":"timeline.p","component":"p","content":{"text":"first paragraph"}},{"id":"doc-1b8i1me1d0","identifier":"timeline.p","component":"p","content":{"text":"second paragraph"}}],"references":[{"id":"YbzTpusGyJtF","type":"language-group","location":"metadata","propertyName":"language"}]}]}}}}}}}}}},"externalDocs":{"description":"Find out more about Livingdocs","url":"http://docs.livingdocs.io"},"servers":[{"url":"http://localhost:9090","description":"localhost"},{"url":"{protocol}://{hostname}","description":"downstream","variables":{"protocol":{"enum":["http","https"],"default":"https"},"hostname":{"default":"example.com"}}}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Systemdata":{"type":"object","properties":{"projectId":{"type":"number"},"channelId":{"type":"number"},"documentId":{"type":"number"},"contentType":{"type":"string"},"documentType":{"type":"string"},"publicationId":{"type":"number"},"firstPublicationDate":{"type":"string","format":"date-time"},"significantPublicationDate":{"type":"string","format":"date-time"},"visiblePublicationDate":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"layout":{"type":"string"},"design":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}}},"Metadata":{"type":"object"},"Content":{"type":"array","items":{"type":"object"}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"number"},"error":{"type":"string"},"error_details":{"type":"object","properties":{"message":{"type":"string"}}}}},"Renditions":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"content":{"oneOf":[{"type":"string","format":"html"},{"type":"object"}]}}}},"References":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"location":{"type":"string"},"propertyName":{"type":"string"}}}},"MediaLibraryEntryAsset":{"type":"object","additionalProperties":false,"properties":{"storage":{"deprecated":true,"type":"string"},"key":{"type":"string"},"url":{"type":"string","format":"url"},"width":{"type":"integer"},"height":{"type":"integer"},"size":{"type":"integer"},"duration":{"type":"number"},"mimeType":{"type":"string"},"filename":{"type":"string"}}},"MediaLibraryEntry":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"version":{"type":"number"},"mediaType":{"type":"string"},"asset":{"$ref":"#/components/schemas/MediaLibraryEntryAsset"},"metadata":{"type":"object"},"translations":{"$ref":"#/components/schemas/MediaLibraryTranslations"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MediaLibraryTranslations":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["locale","metadata"],"properties":{"locale":{"type":"string","pattern":"^[a-z][a-zA-Z0-9\\-]+$"},"metadata":{"title":"Metadata","type":"object","additionalProperties":true},"asset":{"$ref":"#/components/schemas/MediaLibraryEntryAsset"}}}},"CompositionApiRequestBody":{"type":"object","examples":[{"fields":["systemdata","metadata","content","html","includes","design"],"metadata":{"preload":{"myMetadataProp":true}},"resolveIncludes":true,"renderOptions":{"renderDirectiveInfo":true}}],"properties":{"fields":{"type":"array","items":{"type":"string","enum":["systemdata","metadata","content","html","includes","design"]}},"metadata":{"type":"object","additionalProperties":false,"properties":{"preload":{"type":"object"}}},"resolveIncludes":{"type":"boolean"},"renderOptions":{"type":"object","additionalProperties":false,"properties":{"renderDirectiveInfo":{"type":"boolean"}}}}},"CompositionApiResponse":{"type":"object","properties":{"systemdata":{"$ref":"#/components/schemas/Systemdata"},"metadata":{"$ref":"#/components/schemas/Metadata"},"content":{"$ref":"#/components/schemas/Content"},"includes":{"type":"array","items":{"type":"object","properties":{"componentId":{"type":"string"},"directiveName":{"type":"string"},"resolvedValue":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"component":{"type":"string"},"content":{"type":"object"}}}}}}}}},"html":{"type":"string"}},"examples":[{"systemdata":{"projectId":1,"channelId":1,"documentId":1,"contentType":"article","documentType":"article","publicationId":1,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2023-03-18T16:32:04.170Z","design":{"name":"timeline","version":"1.1.0"}},"content":[{"id":"doc-1b8i1ksh10","identifier":"timeline.head","component":"head","content":{"title":"a title","text":"some lead"}},{"id":"doc-2c95a77x14","identifier":"timeline.teaser","component":"teaser","content":{"embed-teaser":{"service":"embed-teaser","params":{"document":{"'$ref'":"document","reference":{"id":7}}}}}}],"metadata":{"title":"a title","description":"some lead","topic":{"'$ref'":"document","reference":{"id":"5"},"isPreloaded":true,"value":{"metadata":{"title":"Another title"},"systemdata":{"projectId":1,"channelId":1,"documentId":5,"contentType":"article","documentType":"article","publicationId":7,"firstPublicationDate":"2022-03-16T14:08:11.000Z","significantPublicationDate":"2022-10-26T07:25:00.000Z","visiblePublicationDate":"2022-10-27T06:00:00.000Z","updatedAt":"2023-03-18T17:32:04.170Z","design":{"name":"timeline","version":"1.1.0"}}}}},"includes":[{"componentId":"doc-2c95a77x14","directiveName":"embed-teaser","resolvedValue":{"content":[{"id":"ref-7","component":"p","content":{"text":"Some text."}}]}}],"html":"