curl --request POST \
--url https://api.{environment}.corti.app/v2/documents/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '{
"name": "<string>",
"inheritFromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"languages": [
"<string>"
],
"regions": [
"<string>"
],
"specialties": [
"<string>"
],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"publish": true
}'{
"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,
"source": "user",
"description": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "2023-11-07T05:31:56Z",
"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,
"source": "user",
"description": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "2023-11-07T05:31:56Z",
"publishedVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionNumber": 123,
"generation": {
"heading": "<string>",
"instructions": {
"contentPrompt": "<string>",
"writingStylePrompt": "<string>",
"miscPrompt": "<string>"
},
"outputSchema": {
"type": "string",
"description": "<string>",
"default": "<string>",
"enum": [
"<string>"
],
"pattern": "<string>"
}
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}
]
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}Create template
Creates a new template with an initial version. When publish is true (default),
the response includes the published version with full inheritance resolution applied
(template-level and section-level inheritance walked).
curl --request POST \
--url https://api.{environment}.corti.app/v2/documents/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '{
"name": "<string>",
"inheritFromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"languages": [
"<string>"
],
"regions": [
"<string>"
],
"specialties": [
"<string>"
],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"publish": true
}'{
"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,
"source": "user",
"description": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "2023-11-07T05:31:56Z",
"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,
"source": "user",
"description": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "2023-11-07T05:31:56Z",
"publishedVersion": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionNumber": 123,
"generation": {
"heading": "<string>",
"instructions": {
"contentPrompt": "<string>",
"writingStylePrompt": "<string>",
"miscPrompt": "<string>"
},
"outputSchema": {
"type": "string",
"description": "<string>",
"default": "<string>",
"enum": [
"<string>"
],
"pattern": "<string>"
}
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}
]
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}Authorizations
Input your token
Headers
Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.
"base"
Body
- Inherit from existing template
- Create from scratch
Creates a template that inherits from another template. Any fields omitted in generation are inherited from the referenced template's published version; any fields provided override the inherited values.
The name of this template. Not passed to the LLM.
Reference to the template to inherit instructions and sections from. Inherits from the published version of the referenced template.
A description for this template. Not passed to the LLM.
BCP 47 language tags this template has been tweaked for (e.g. ["fr", "de", "en-GB"]).
ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. ["BEL"]).
Clinical specialties this template has been tweaked for.
Labels work as query param filter in the LIST /templates endpoint.
Show child attributes
Show child attributes
Defaults to true when omitted. Set this to false if you do not want the template to automatically show up in LIST templates.
Partial overrides applied on top of the inherited template. All inner fields are optional. Any field omitted is inherited from the referenced template.
Show child attributes
Show child attributes
Response
Created
Template as returned by single-resource endpoints (GET, POST, PATCH on
/documents/templates/{templateID}). Extends GuidedTemplateListItem with the resolved
publishedVersion.
The UUID of the template.
The name of this template. Not passed to the LLM.
BCP 47 language tags this template has been tweaked for (e.g. ["fr", "de", "en-GB"]). Empty means no language-specific tweaks.
ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. ["BEL"]). Empty means no region-specific tweaks.
Clinical specialties this template has been tweaked for. Empty means no specialty-specific tweaks.
The available labels to use as query param filter in the LIST /templates endpoint.
Show child attributes
Show child attributes
The original timestamp when the template was created.
The original timestamp when the template was last updated.
Reference to the template to inherit template instructions and sections from. Inherits from published version by default.
True if the template was auto-generated based on the section-composed POST /documents request.
Whether this template was created by the user, a project-related API Client or is a Corti standard resource.
user, corti, project A description for this template. Not passed to the LLM.
The UUID of the creator of this template.
Present when the template has been deleted. GET by ID still returns the full resource with this field populated.
The currently published version with inheritance fully resolved. Present when a version has been published.
Show child attributes
Show child attributes
Was this page helpful?