Sign in
Guided Documents

Get document

Returns a previously generated document by ID, including its rendered string output and structured object.

get/documents/{documentID}

Response

OK

idstring uuid required
namestring required
templateIdstring uuid required

The template ID used for generation. For a plain templateRef with no overrides this is the referenced template. For other paths it is the newly saved auto-generated template aggregate.

templateVersionIdstring uuid required

The specific template version that was used for generation.

languagestring required

The BCP 47 language tag of the generated output.

interactionIdstring uuid nullable

The interaction whose context was used to generate this document, if supplied.

stringDocumentobject required

The generated document as a map of section key to rendered string output.

structuredDocumentobject nullable

The generated document as a structured object keyed by section.

createdAtstring date-time required
updatedAtstring date-time required

Changes