Run a Document Generator

This is where you start a generation, with all the necessary options. Each of the desired outputs must be specified in the "outputs" array. If you do not specify any outputs, this endpoint will return a 4xx error. Note: Generated outputs are only available for download for 24 hours from time of generation.
The request body must include all required ad hoc inputs and at least one output. Optional inputs include variable list data, image upload content input, manual select content input, and form selection. When the request is successful, the API returns a generated LiveDoc identifier that can be used to poll generation status and download outputs. Returns 400 for invalid request bodies, unsupported output format combinations, or if the specified template version cannot be found or parsed. Returns 401 when authentication fails and 403 when the bearer token lacks required scopes. Returns 500 for unexpected server errors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Team site identifier that owns the livedoc template version.

string
required

Content version identifier of the livedoc template.

Query Params
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*
string

Optional form identifier used to select a specific form configuration.

boolean

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json