Create Document Generator output

post

https://api.seismic.com/livedoc/v3/teamsites/{teamSiteId}/livedocVersions/{libraryContentVersionId}

Initiates a Document Generator output creation job with the specified options. Each desired output format must be included in the outputs array — omitting this field will return a 4xx error.
The request body must include all required ad hoc inputs, at least one output format, and optionally variable list data, image upload content input, manual select content input, and output selection. On success, returns a Document Generator output ID that can be used to poll for status and download the output.
Generated outputs are available for download for 24 hours.
Error codes:
400 — Invalid request body, unsupported output format combination, or template version not found or unreadable
401 — Authentication failed
403 — Bearer token lacks required scopes
500 — Unexpected server error

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

teamSiteId

string

required

Team site identifier that owns the livedoc template version.

libraryContentVersionId

string

required

Content version identifier of the livedoc template.

Query Params

liveFormSellerTemplateId

string

Optional seller template identifier used to constrain or prefill ad hoc inputs.

Body Params

Request body for POST /v3/teamsites/{teamSiteId}/livedocVersions/{libraryContentVersionId}.

adHocInputs

array of objects

required

Ad hoc input values keyed by variable name. This property is required by the current implementation.

adHocInputs*

variableListData

array of objects

Variable list input values grouped by variable list name.

variableListData

imageUploadContentInput

object

Image upload content input values keyed by placeholder name.

manualSelectContentInput

object

Manual selection content input values for selectable template content.

outputs

array of objects

required

Output definitions to generate. At least one output is required.

outputs*

formId

string

Optional form identifier used to select a specific form configuration.

useMinorVersionForTest

boolean

When true, generation uses minor versions for test-related content resolution.

regionalFormat

string

Optional regional format culture name, such as en-US. This requires the tenant feature to be enabled.

Responses

500

Unexpected server error while processing the request.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Generation request created successfully.

400Invalid request body, invalid parameters, unsupported output configuration, or template resolution failure.

401Authentication failed because the Authorization header is missing, malformed, expired, or does not contain a valid JWT bearer token.

403Authentication succeeded, but the bearer token lacks one or more scopes required by this operation.