Clinical AssistantcURL
curl --request PATCH \
--url https://api.{environment}.corti.app/v2/documents/sections/{sectionID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '
{
"name": "<string>",
"description": "<string>",
"languages": [
"<string>"
],
"regions": [
"<string>"
],
"specialties": [
"<string>"
],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import { CortiClient, CortiEnvironment } from "@corti/sdk";
const client = new CortiClient({
environment: CortiEnvironment.Eu,
auth: {
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET"
},
tenantName: "YOUR_TENANT_NAME"
});
await client.documents.sections.update("sectionID");
using Corti.Documents;
using Corti;
var client = new CortiClient(
"TENANT_NAME",
CortiClientEnvironment.Eu,
new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Documents.Sections.UpdateAsync("sectionID", new GuidedSectionsUpdateRequest());
import requests
url = "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}"
payload = {
"name": "<string>",
"description": "<string>",
"languages": ["<string>"],
"regions": ["<string>"],
"specialties": ["<string>"],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"Tenant-Name": "<tenant-name>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'languages' => [
'<string>'
],
'regions' => [
'<string>'
],
'specialties' => [
'<string>'
],
'labels' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Name: <tenant-name>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"specialties\": [\n \"<string>\"\n ],\n \"labels\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Tenant-Name", "<tenant-name>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.{environment}.corti.app/v2/documents/sections/{sectionID}")
.header("Tenant-Name", "<tenant-name>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"specialties\": [\n \"<string>\"\n ],\n \"labels\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();{
"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"
}
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}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}
cURL
curl --request PATCH \
--url https://api.{environment}.corti.app/v2/documents/sections/{sectionID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '
{
"name": "<string>",
"description": "<string>",
"languages": [
"<string>"
],
"regions": [
"<string>"
],
"specialties": [
"<string>"
],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import { CortiClient, CortiEnvironment } from "@corti/sdk";
const client = new CortiClient({
environment: CortiEnvironment.Eu,
auth: {
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET"
},
tenantName: "YOUR_TENANT_NAME"
});
await client.documents.sections.update("sectionID");
using Corti.Documents;
using Corti;
var client = new CortiClient(
"TENANT_NAME",
CortiClientEnvironment.Eu,
new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Documents.Sections.UpdateAsync("sectionID", new GuidedSectionsUpdateRequest());
import requests
url = "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}"
payload = {
"name": "<string>",
"description": "<string>",
"languages": ["<string>"],
"regions": ["<string>"],
"specialties": ["<string>"],
"labels": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"Tenant-Name": "<tenant-name>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'languages' => [
'<string>'
],
'regions' => [
'<string>'
],
'specialties' => [
'<string>'
],
'labels' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Name: <tenant-name>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{environment}.corti.app/v2/documents/sections/{sectionID}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"specialties\": [\n \"<string>\"\n ],\n \"labels\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Tenant-Name", "<tenant-name>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.{environment}.corti.app/v2/documents/sections/{sectionID}")
.header("Tenant-Name", "<tenant-name>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"languages\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"specialties\": [\n \"<string>\"\n ],\n \"labels\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();{
"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"
}
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}{
"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.
Example:
"base"
Path Parameters
Body
application/json
A human-readable identifier for this section. Not passed to the LLM.
A description for this section. Not passed to the LLM.
BCP 47 language tags this section has been tweaked for.
ISO 3166-1 alpha-3 country codes this section has been tweaked for.
Clinical specialties this section has been tweaked for.
Labels work as query param filter in the LIST /sections endpoint.
Show child attributes
Show child attributes
Response
OK
Section as returned by single-resource endpoints (GET, POST, PATCH on
/documents/sections/{sectionID}) and when embedded inside a resolved template
version. Extends GuidedSectionListItem with the resolved publishedVersion.
The UUID of the section.
The name of the section.
BCP 47 languages this section has been tweaked for. Empty means no language-specific tweaks.
ISO 3166-1 alpha-3 country codes this section has been tweaked for. Empty means no region-specific tweaks.
Clinical specialties this section has been tweaked for. Empty means no specialty-specific tweaks.
The labels available to use as query param filter in the LIST /sections endpoint.
Show child attributes
Show child attributes
The original timestamp when the section was created.
The original timestamp when the section was last updated.
Reference to the section to inherit generation configuration from. Inherits from published version by default.
True if the section was auto-generated as part of an inline section-composed POST /documents request.
Whether this section was created by the user, a project-related API Client or is a Corti standard resource.
Available options:
user, corti, project The description for the section.
The UUID of the creator of this section.
Present when the section has been deleted. GET by ID still returns the full resource with this field populated.
The currently published version with section inheritance fully resolved. Present when a version has been published.
Show child attributes
Show child attributes
Was this page helpful?