Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Transcripts

Create Transcript

Create a transcript from an audio file uploaded to the interaction via /recordings endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 120 minutes in total audio duration and 150 MB in size may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the async parameter to true to receive the location header immediately and process the request asynchronously. Read more here.</Note>

post/interactions/{id}/transcripts/

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.

Request body

recordingIdstring uuid required
primaryLanguagestring required

The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more.

spokenPunctuationboolean

When true, converts spoken punctuation such as 'period' or 'slash' into symbols (e.g., '.', '/'). When enabled, automatic punctuation is turned off. Takes precedence over automaticPunctuation when both are enabled.

automaticPunctuationboolean

When true, automatically punctuates and capitalizes the transcript. Defaults to true. Overridden by spokenPunctuation when both are enabled.

isDictationboolean

Deprecated — replaced by spokenPunctuation and automaticPunctuation. Ignored when either of those fields is provided. When true and neither new field is provided, it is treated as spokenPunctuation: true (automatic punctuation off). No removal date is currently planned.

isMultichannelboolean

If true, each audio channel is transcribed separately.

diarizeboolean

If true, separates speakers within an audio channel returning incrementing ids for transcript segments.

asyncboolean

If true, the request will return immediately with a 202 status and the transcript will be processed asynchronously. Poll Get Transcript Status to check transcript processing status - processing, completed, failed.

Example request

{
  "recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "primaryLanguage": "en"
}

Response

Returns the generated transcript, including participant roles and timestamps for each utterance.

idstring uuid required
recordingIdstring uuid required
status'completed' | 'processing' | 'failed' required

Possible values for transcript processing status.

Example response

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