Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Guided Templates

List templates

Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections. Use query parameters to filter by language, region, specialty, label, publish status, or source.

get/documents/templates/

Query parameters

langstring[]

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

regionstring[]

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

specialtystring[]

Filter templates by clinical specialty. Repeatable.

labelstring[]

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

publishedboolean

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

source'user' | 'corti'

Filter by content source.

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

Headers

Tenant-Namestring required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:base

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

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.