Update Document

PATCH /interactions/{id}/documents/{documentId}

cURL

cURL

curl --request PATCH \
  --url https://api.{environment}.corti.app/v2/interactions/{id}/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '
{
  "name": "<string>",
  "sections": [
    {
      "key": "<string>",
      "name": "<string>",
      "text": "<string>",
      "sort": 123
    }
  ]
}
'

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.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");

using Corti;

var client = new CortiClient(
    "TENANT_NAME",
    CortiClientEnvironment.Eu,
    new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Documents.UpdateAsync(
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    new DocumentsUpdateRequest()
);

import requests

url = "https://api.{environment}.corti.app/v2/interactions/{id}/documents/{documentId}"

payload = {
    "name": "<string>",
    "sections": [
        {
            "key": "<string>",
            "name": "<string>",
            "text": "<string>",
            "sort": 123
        }
    ]
}
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/interactions/{id}/documents/{documentId}",
  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>',
    'sections' => [
        [
                'key' => '<string>',
                'name' => '<string>',
                'text' => '<string>',
                'sort' => 123
        ]
    ]
  ]),
  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/interactions/{id}/documents/{documentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"sections\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"text\": \"<string>\",\n      \"sort\": 123\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/interactions/{id}/documents/{documentId}")
  .header("Tenant-Name", "<tenant-name>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"sections\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"text\": \"<string>\",\n      \"sort\": 123\n    }\n  ]\n}")
  .asString();

200

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "<string>",
  "templateRef": "<string>",
  "isStream": true,
  "sections": [
    {
      "key": "<string>",
      "name": "<string>",
      "text": "<string>",
      "sort": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "outputLanguage": "<string>",
  "usageInfo": {
    "creditsConsumed": 123
  }
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

Authorizations

Authorization · string · header · required

Input your token

Headers

Tenant-Name · string · required

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

Example:

"base"

Path Parameters

id · string<uuid> · required

The unique identifier of the interaction. Must be a valid UUID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

documentId · string<uuid> · required

The document ID representing the context for the request. Must be a valid UUID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json

name · string

An optional name for the document.

sections · object[]

Show child attributes

Response

200

application/json

id · string<uuid> · required

Unique ID of the generated document

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

name · string · required

Name of the generated document

templateRef · string · required

Reference for the used template

isStream · boolean · required

sections · object[] · required

Individual document sections

Show child attributes

createdAt · string<date-time> · required

The original timestamp when the document was created.

updatedAt · string<date-time> · required

The timestamp when the document was last updated.

outputLanguage · string · required

The language in which the document will be generated. Check https://docs.corti.ai/stt/languages for more.

usageInfo · object · required

Credits consumed for this request.

Show child attributes