Sign in

5d1895a1b3fc

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Guided Sections

Update section metadata

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

patch/documents/sections/{sectionID}

Request body

namestring

A human-readable identifier for this section. Not passed to the LLM.

descriptionstring

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

languagesstring[]

BCP 47 language tags this section has been tweaked for.

regionsstring[]

ISO 3166-1 alpha-3 country codes this section has been tweaked for.

specialtiesstring[]

Clinical specialties this section has been tweaked for.

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.

Example response

{
  "publishedVersion": {
    "generation": {
      "outputSchema": {
        "itemFormat": "- {item}\n"
      }
    }
  }
}