Get a signed inline-view URL for a document asset
Returns a short-lived signed URL for rendering a `document` asset inline in the viewer. Serves the processed `media` derivative (an optimised PDF with permission flags stripped), not the original — downloads of the original go through `POST /assets/download`. Requires `canGetAsset`. The asset must be `active`, have `mediaType: 'document'`, and have an active `media` file (i.e. post-processing finished successfully); otherwise a 400 is returned and the client should fall back to the file card. The `media` PDF is capped at a maximum page count, so `pagesTruncated`, `truncatedFrom` and `originalPageCount` tell the viewer whether and where pages are missing.
Returns a short-lived signed URL for rendering a document asset inline in the
viewer. Serves the processed media derivative (an optimised PDF with permission
flags stripped), not the original — downloads of the original go through
POST /assets/download. Requires canGetAsset.
The asset must be active, have mediaType: 'document', and have an active
media file (i.e. post-processing finished successfully); otherwise a 400 is
returned and the client should fall back to the file card.
The media PDF is capped at a maximum page count, so pagesTruncated,
truncatedFrom and originalPageCount tell the viewer whether and where pages
are missing.
OAuth 2.1 authorization code flow with PKCE (required of every client, public or confidential). Scopes are a ceiling on the credential, not a grant of access: a token also cannot exceed what the user who approved it may already do. A write scope does not imply its matching read — ask for both.
In: header
Scope: assets:read
Path Parameters
ID of the document asset to view.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/assets/497f6eca-6276-4993-bfeb-53cbbbba6f08/document-url"{ "url": "string", "expires": 1705988395, "pageCount": 0, "pagesTruncated": true, "truncatedFrom": "start", "originalPageCount": 0}