Tagged Document Details

Changed on

This API retrieves details of the pages and tagged elements within a specified document. It returns a paginated list of the document's pages and metadata about each page. If the document has tagged elements, the API includes their respective details, such as size and position. If the document does not have tagged elements, it returns an empty array. The response includes pagination information to help users navigate the document’s pages. A maximum of 10 pages can be returned in 1 API call.

get/beta/tagged-documents/{documentId}

Request

  • Base URL: https://express-api.adobe.io
  • URL: https://express-api.adobe.io/beta/tagged-documents/{documentId}
  • Auth: API key in header X-API-KEY and HTTP bearer

Path parameters

documentIdstring required

The unique identifier of the document.

Query parameters

startinteger

Specifies the starting document page number from which details need to be fetched. Default is 1.

Response

Successfully retrieved the details of the tagged document.

namestring required

The name of the document.

idstring required

The unique identifier of the document.

Changes

  • 5305b6e7397bRevision changes
    • info

      added the optional property //// to the response with the status