inklet docs

Render a stored scene again

POST/api/sdk/v1/presentations/{presentationId}/renditions

Rasterises the presentation's stored scene at another size or color mode. No AI runs and the scene itself is never changed.

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token created in the inklet portal. Server-side use only.

In: header

Path Parameters

presentationId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Requested output for a display-free result. preset and viewport are mutually exclusive; formats defaults to both.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/sdk/v1/presentations/string/renditions" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "mediaType": "image/png",  "format": "png",  "width": 1,  "height": 1,  "colorMode": "color",  "state": "preparing",  "url": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "failure": {    "code": "string",    "message": "string",    "stage": "string",    "retryable": true,    "assetIndex": 0  }}