Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Documents (Classic)

Generate Document

This endpoint offers different ways to generate a document. Find guides to document generation here.

post/interactions/{id}/documents/

Path parameters

idstring uuid required
Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

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

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.

X-Corti-Retention-Policy'none'

With the optional header X-Corti-Retention-Policy:none the API will generate and return the document as expected, but the generated document will not be saved to the database. The response will include the header X-Corti-Retention-Policy:acknowledged to confirm that your retention preference was respected. If the header is omitted or set to any other value, the default retention policy will apply, and the document will be stored in the database.

Request body

OR

Example request

{
  "context": [
    {
      "data": [
        {
          "group": "Others"
        }
      ]
    }
  ],
  "documentationMode": "global_sequential"
}

Response

idstring uuid required
namestring required

Name of the generated document

templateRefstring required

Reference for the used template

isStreamboolean required
createdAtstring date-time required

The original timestamp when the document was created.

updatedAtstring date-time required

The timestamp when the document was last updated.

outputLanguagestring required

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

Example response

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}