Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Guided Sections

List sections

Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content. Use query parameters to filter by language, region, specialty, label, publish status, or source.

get/documents/sections/

Query parameters

langstring[]

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

regionstring[]

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

specialtystring[]

Filter sections by clinical specialty. Repeatable.

labelstring[]

Filter sections by label in key:value format. Repeatable; matches sections 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-created sections; corti returns only Corti standard sections.

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 section.

inheritedFromIdstring uuid nullable

Reference to the section to inherit generation configuration from. Inherits from published version by default.

autoGeneratedboolean

True if the section was auto-generated as part of an inline section-composed POST /documents request.

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

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

namestring required

The name of the section.

languagesstring[] required

BCP 47 languages this section has been tweaked for. Empty means no language-specific tweaks.

regionsstring[] required

ISO 3166-1 alpha-3 country codes this section has been tweaked for. Empty means no region-specific tweaks.

specialtiesstring[] required

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

descriptionstring

The description for the section.

createdBystring uuid

The UUID of the creator of this section.

createdAtstring date-time required

The original timestamp when the section was created.

updatedAtstring date-time required

The original timestamp when the section was last updated.

deletedAtstring date-time nullable

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