Skip to main content
GET
/
documents
List documents
curl --request GET \
  --url https://api.{environment}.corti.app/v2/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-Name: <tenant-name>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "templateVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "language": "<string>",
    "stringDocument": {},
    "labels": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "structuredDocument": {}
  }
]

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.

​
language
string
required

The BCP 47 language tag of the generated output.

​
stringDocument
object
required

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

​
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

The generated document as a structured object keyed by section.