v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB

Guided Documents

List documents

Returns a list of previously generated documents. Use query parameters to filter by template, interaction, or label.

get/documents/

Query parameters

templateIdstring uuid

Filter documents by template UUID.

interactionIdstring uuid

Filter documents by interaction UUID.

labelstring[]

Filter documents by label in key:value format. Repeatable; matches documents that have any of the given labels.

Headers

Tenant-Namestring required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:base

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Response

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