Skip to main content
GET
/
documents
/
templates
cURL
curl --request GET \
  --url https://api.{environment}.corti.app/v2/documents/templates/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-Name: <tenant-name>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "languages": [
      "<string>"
    ],
    "regions": [
      "<string>"
    ],
    "specialties": [
      "<string>"
    ],
    "labels": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "inheritedFromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "autoGenerated": true,
    "description": "<string>",
    "policies": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "customerIds": [
          "<string>"
        ]
      }
    ],
    "publishedVersion": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "versionNumber": 123,
      "generation": {
        "instructions": {
          "prompt": "<string>"
        },
        "sections": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "languages": [
              "<string>"
            ],
            "regions": [
              "<string>"
            ],
            "specialties": [
              "<string>"
            ],
            "labels": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "inheritedFromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "autoGenerated": true,
            "description": "<string>",
            "publishedVersion": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "versionNumber": 123,
              "generation": {
                "heading": "<string>",
                "instructions": {
                  "contentPrompt": "<string>",
                  "writingStylePrompt": "<string>",
                  "miscPrompt": "<string>"
                },
                "outputSchema": {
                  "description": "<string>",
                  "default": "<string>",
                  "enum": [
                    "<string>"
                  ],
                  "pattern": "<string>"
                }
              },
              "deletedAt": "2023-11-07T05:31:56Z"
            },
            "deletedAt": "2023-11-07T05:31:56Z",
            "policies": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "sectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "customerIds": [
                  "<string>"
                ]
              }
            ]
          }
        ]
      },
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "deletedAt": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.corti.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
lang
string[]

Filter templates by BCP 47 language tag (e.g. fr, de, or en-GB). Repeatable.

​
region
string[]

Filter templates by ISO 3166-1 alpha-3 region code (e.g. BEL). Repeatable.

​
specialty
string[]

Filter templates by clinical specialty. Repeatable.

​
label
string[]

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

​
published
boolean

Filter by publish status. Omit to return both published and unpublished items; set to true for published only, false for unpublished only.

​
source
enum<string>

Filter by source. Omit to return both. user returns only user/client-created templates; corti returns only Corti standard templates.

Available options:
user,
corti

Response

200 - application/json

OK

​
id
string<uuid>
required

The UUID of the template.

​
name
string
required

The name of this template. Not passed to the LLM.

​
languages
string[]
required

BCP 47 language tags this template has been tweaked for (e.g. ["fr", "de", "en-GB"]). Empty means no language-specific tweaks.

​
regions
string[]
required

ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. ["BEL"]). Empty means no region-specific tweaks.

​
specialties
string[]
required

Clinical specialties this template has been tweaked for. Empty means no specialty-specific tweaks.

​
labels
object[]
required

The available labels to use as query param filter in the LIST /templates endpoint.

​
createdAt
string<date-time>
required

The original timestamp when the template was created.

​
updatedAt
string<date-time>
required

The original timestamp when the template was last updated.

​
inheritedFromId
string<uuid> | null

Reference to the template to inherit template instructions and sections from. Inherits from published version by default.

​
autoGenerated
boolean

True if the template was auto-generated based on the section-composed POST /documents request.

​
source
enum<string>

Whether this template was created by the user or is a Corti standard resource.

Available options:
user,
corti
​
description
string

A description for this template. Not passed to the LLM.

​
policies
object[]

Access policies for this template.

​
publishedVersion
object

The currently published version with inheritance fully resolved. Present when a version has been published.

​
deletedAt
string<date-time> | null

Present when the template has been deleted. GET by ID still returns the full resource with this field populated.