Skip to main content
GET
/
templates
/
{key}
cURL
curl --request GET \
  --url https://api.{environment}.corti.app/v2/templates/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-Name: <tenant-name>'
{
  "name": "<string>",
  "description": "<string>",
  "key": "<string>",
  "status": "<string>",
  "templateSections": [
    {
      "sort": 123,
      "section": {
        "name": "<string>",
        "key": "<string>",
        "description": "<string>",
        "defaultWritingStyle": {
          "name": "<string>"
        },
        "type": "<string>",
        "translations": [
          {
            "languageId": "<string>",
            "name": "<string>",
            "description": "<string>"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z",
        "alternateName": "<string>",
        "defaultFormatRule": {
          "name": "<string>"
        },
        "additionalInstructions": "<string>",
        "content": "<string>",
        "documentationMode": "global_sequential"
      }
    }
  ],
  "translations": [
    {
      "languageId": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "additionalInstructions": "<string>",
  "documentationMode": "global_sequential"
}

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"

Path Parameters

key
string
required

The key of the template

Response

Template by key

name
string
required

Name of the template.

description
string
required

Description of the template.

key
string
required

Unique key for the template.

status
string
required

Status of the template.

templateSections
object[]
required

List of sections included in the template.

translations
object[]
required

Available translations for the template.

updatedAt
string<date-time> | null

The timestamp when the template was updated.

additionalInstructions
string | null

Instructions or context for all template sections.

documentationMode
enum<string>

Configures the approach and underlying system prompt that govern how the LLM generates documentation.

Available options:
global_sequential,
routed_parallel
Example:

"global_sequential"