Assets

Retrieve specific asset preview

Retrieve a rendered preview of a specific asset. The returned url is publicly accessible without authentication. A 202 response with url set to null means the preview is still being generated; the client should poll this endpoint again until a 200 is returned.

Use the client and details query parameters to control how the preview is rendered. client applies to both the png and pdf formats. details only takes effect for format=pdf with client=desktop; it is ignored for png and for pdf with client=mobile.

get/assets/{asset_id}/preview

Request

Base URL
https://enterprise.knak.io/api/published/v1
Auth
none declared
TypeScript
https://skmtc.dev/knak/apis/knak-enterprise-api/docs/assets/:asset_id/preview/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

asset_idstring required

ID of asset

Query parameters

format'png' | 'pdf'

Preview format

client'desktop' | 'mobile'

The client to render the preview for. Applies to both png and pdf formats.

detailsboolean

Whether to include the email details header in the preview. Only takes effect for format=pdf with client=desktop, where false omits the details header. Ignored for png (any client) and for pdf with client=mobile, where the details header is always included. Defaults to true.

Response

Preview is ready. The url is populated and publicly accessible.

Example response

{
  "data": {
    "id": "609d7ce223411",
    "format": "png",
    "client": "desktop",
    "details": true,
    "url": "https://cdn.example.com/preview-desktop.png"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.