Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

Input your token

Headers

Tenant-Name
string
required

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

Example:

"base"

Query Parameters

templateId
string<uuid>

Filter documents by template UUID.

interactionId
string<uuid>

Filter documents by interaction UUID.

label
string[]

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

Response

OK

id
string<uuid>
required
name
string
required
templateId
string<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.

templateVersionId
string<uuid>
required

The specific template version that was used for generation.

outputLanguage
string
required

The BCP 47 language tag of the generated output.

stringDocument
object
required

The generated document as a map of section ID to rendered string output. The sections array lists every section ID and its heading.

labels
object[]
required

Key/value labels attached to this document.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
interactionId
string<uuid> | null

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

structuredDocument
object | null

The generated document as a structured object keyed by section ID. The sections array lists every section ID and its heading.

sections
object[]

Every section in the template version, in template order, including sections the model left empty. Use sectionId as the key into stringDocument and structuredDocument. The heading and labels let you render the section without a GET request per section.

Example: