Sign in
latestOpenAPI 3.1.0Proprietary - Prezent, Inc.2026-08-114675175.5 KB

a01cb764a085

Template Converter

Create a template-conversion job

Kicks off a pipeline that applies the target brand template (templateName) to the input PowerPoint (fileId or inputDeck). Returns a callback_id to poll. Counted against the TC_START usage limit.

Subsequent calls in the same conversion lifecycle: poll GET /api/v1/template-converter/status/{callbackId} until the pipeline reaches a terminal state.

post/api/v1/template-converter/start

Headers

Idempotency-Keystring
Example:8e6df756-18f6-4f16-8e12-7d7a5c5cb181

Optional client-generated key (a UUID is ideal) that makes a write request safe to retry. The first request is processed and its response cached for 24 hours; an identical retry with the same key returns the cached response plus an Idempotency-Replayed: true header, so the job is never created twice. Reusing a key with a different body returns 409 IDEMPOTENCY_KEY_REUSED_WITH_DIFFERENT_BODY.

Request body

fileIdstring

Identifier of a previously uploaded input deck. Supply either fileId or inputDeck.

templateNamestring required

Code of the target brand template. Must be one the caller's company is authorised to use — an unknown or unauthorised code is rejected.

includeImageWithoutDataboolean

Carry over images that have no associated data.

includeImageWithDataboolean

Carry over images that have associated data.

includeIconsboolean

Carry over icons.

includeSpecialColorboolean

Preserve special color treatments from the source deck.

color_preference'standard' | 'advanced'

Color treatment preference. Also accepted as colorPreference.

content_formatting_preference'standard' | 'advanced'

Content-formatting preference. Also accepted as contentFormattingPreference.

modifyFormat'source' | 'target'

Which deck's formatting to apply. Also accepted as modify_format.

Response

Job accepted; client must poll for completion.

callbackIdstring required

Conversion job id to poll. Note the camelCase spelling.

status'processing' | 'failed' required

processing once the pipeline has been accepted; failed if it could not be started.

presentationNamestring

Resolved presentation name. May be an empty string.

tokenstring

Token for callback-id-scoped URLs.