Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Guided Templates

Update template metadata

Updates the template's metadata fields (name, description, languages, regions, specialties, labels). Generation content (template instructions, section composition) is managed through versions and cannot be updated here.

patch/documents/templates/{templateID}

Request body

namestring

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

descriptionstring

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

languagesstring[]

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

regionsstring[]

ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. ["BEL"]).

specialtiesstring[]

Clinical specialties this template has been tweaked for.

Response

OK

idstring uuid required

The UUID of the template.

inheritedFromIdstring uuid nullable

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

autoGeneratedboolean

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

source'user' | 'corti' | 'project'

Whether this template was created by the user, a project-related API Client or is a Corti standard resource.

namestring required

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

descriptionstring

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

languagesstring[] required

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

regionsstring[] required

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

specialtiesstring[] required

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

createdBystring uuid

The UUID of the creator of this template.

createdAtstring date-time required

The original timestamp when the template was created.

updatedAtstring date-time required

The original timestamp when the template was last updated.

deletedAtstring date-time nullable

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