curl --request POST \
--url https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '
{
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"primaryLanguage": "en",
"spokenPunctuation": true,
"automaticPunctuation": true,
"formatting": {},
"isDictation": true,
"isMultichannel": true,
"diarize": true,
"participants": [
{
"channel": 1,
"role": "<string>"
}
],
"async": true,
"replacements": [
{
"find": "<string>",
"replace": "<string>"
}
],
"keyterms": {
"terms": [
{
"term": "<string>"
}
]
},
"wordLevel": {
"enabled": true
}
}
'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.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
primaryLanguage: "en"
});
using Corti;
var client = new CortiClient(
"TENANT_NAME",
CortiClientEnvironment.Eu,
new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Transcripts.CreateAsync(
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
new TranscriptsCreateRequest
{
RecordingId = "f47ac10b-58cc-4372-a567-0e02b2c3d479",
PrimaryLanguage = "en",
}
);
import requests
url = "https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/"
payload = {
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"primaryLanguage": "en",
"spokenPunctuation": True,
"automaticPunctuation": True,
"formatting": {},
"isDictation": True,
"isMultichannel": True,
"diarize": True,
"participants": [
{
"channel": 1,
"role": "<string>"
}
],
"async": True,
"replacements": [
{
"find": "<string>",
"replace": "<string>"
}
],
"keyterms": { "terms": [{ "term": "<string>" }] },
"wordLevel": { "enabled": True }
}
headers = {
"Tenant-Name": "<tenant-name>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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}/transcripts/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recordingId' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
'primaryLanguage' => 'en',
'spokenPunctuation' => true,
'automaticPunctuation' => true,
'formatting' => [
],
'isDictation' => true,
'isMultichannel' => true,
'diarize' => true,
'participants' => [
[
'channel' => 1,
'role' => '<string>'
]
],
'async' => true,
'replacements' => [
[
'find' => '<string>',
'replace' => '<string>'
]
],
'keyterms' => [
'terms' => [
[
'term' => '<string>'
]
]
],
'wordLevel' => [
'enabled' => true
]
]),
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}/transcripts/"
payload := strings.NewReader("{\n \"recordingId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"primaryLanguage\": \"en\",\n \"spokenPunctuation\": true,\n \"automaticPunctuation\": true,\n \"formatting\": {},\n \"isDictation\": true,\n \"isMultichannel\": true,\n \"diarize\": true,\n \"participants\": [\n {\n \"channel\": 1,\n \"role\": \"<string>\"\n }\n ],\n \"async\": true,\n \"replacements\": [\n {\n \"find\": \"<string>\",\n \"replace\": \"<string>\"\n }\n ],\n \"keyterms\": {\n \"terms\": [\n {\n \"term\": \"<string>\"\n }\n ]\n },\n \"wordLevel\": {\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/")
.header("Tenant-Name", "<tenant-name>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recordingId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"primaryLanguage\": \"en\",\n \"spokenPunctuation\": true,\n \"automaticPunctuation\": true,\n \"formatting\": {},\n \"isDictation\": true,\n \"isMultichannel\": true,\n \"diarize\": true,\n \"participants\": [\n {\n \"channel\": 1,\n \"role\": \"<string>\"\n }\n ],\n \"async\": true,\n \"replacements\": [\n {\n \"find\": \"<string>\",\n \"replace\": \"<string>\"\n }\n ],\n \"keyterms\": {\n \"terms\": [\n {\n \"term\": \"<string>\"\n }\n ]\n },\n \"wordLevel\": {\n \"enabled\": true\n }\n}")
.asString();{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"metadata": {
"participantsRoles": [
{
"channel": 1,
"role": "<string>"
}
]
},
"transcripts": [
{
"channel": 123,
"participant": 123,
"speakerId": 123,
"text": "<string>",
"start": 123,
"end": 123
}
],
"usageInfo": {
"creditsConsumed": 123
},
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "completed"
}{
"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": [
{}
]
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}Create Transcript
Create a transcript from an audio file uploaded to the interaction via /recordings endpoint.
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.curl --request POST \
--url https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Name: <tenant-name>' \
--data '
{
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"primaryLanguage": "en",
"spokenPunctuation": true,
"automaticPunctuation": true,
"formatting": {},
"isDictation": true,
"isMultichannel": true,
"diarize": true,
"participants": [
{
"channel": 1,
"role": "<string>"
}
],
"async": true,
"replacements": [
{
"find": "<string>",
"replace": "<string>"
}
],
"keyterms": {
"terms": [
{
"term": "<string>"
}
]
},
"wordLevel": {
"enabled": true
}
}
'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.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
primaryLanguage: "en"
});
using Corti;
var client = new CortiClient(
"TENANT_NAME",
CortiClientEnvironment.Eu,
new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Transcripts.CreateAsync(
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
new TranscriptsCreateRequest
{
RecordingId = "f47ac10b-58cc-4372-a567-0e02b2c3d479",
PrimaryLanguage = "en",
}
);
import requests
url = "https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/"
payload = {
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"primaryLanguage": "en",
"spokenPunctuation": True,
"automaticPunctuation": True,
"formatting": {},
"isDictation": True,
"isMultichannel": True,
"diarize": True,
"participants": [
{
"channel": 1,
"role": "<string>"
}
],
"async": True,
"replacements": [
{
"find": "<string>",
"replace": "<string>"
}
],
"keyterms": { "terms": [{ "term": "<string>" }] },
"wordLevel": { "enabled": True }
}
headers = {
"Tenant-Name": "<tenant-name>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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}/transcripts/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recordingId' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
'primaryLanguage' => 'en',
'spokenPunctuation' => true,
'automaticPunctuation' => true,
'formatting' => [
],
'isDictation' => true,
'isMultichannel' => true,
'diarize' => true,
'participants' => [
[
'channel' => 1,
'role' => '<string>'
]
],
'async' => true,
'replacements' => [
[
'find' => '<string>',
'replace' => '<string>'
]
],
'keyterms' => [
'terms' => [
[
'term' => '<string>'
]
]
],
'wordLevel' => [
'enabled' => true
]
]),
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}/transcripts/"
payload := strings.NewReader("{\n \"recordingId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"primaryLanguage\": \"en\",\n \"spokenPunctuation\": true,\n \"automaticPunctuation\": true,\n \"formatting\": {},\n \"isDictation\": true,\n \"isMultichannel\": true,\n \"diarize\": true,\n \"participants\": [\n {\n \"channel\": 1,\n \"role\": \"<string>\"\n }\n ],\n \"async\": true,\n \"replacements\": [\n {\n \"find\": \"<string>\",\n \"replace\": \"<string>\"\n }\n ],\n \"keyterms\": {\n \"terms\": [\n {\n \"term\": \"<string>\"\n }\n ]\n },\n \"wordLevel\": {\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.{environment}.corti.app/v2/interactions/{id}/transcripts/")
.header("Tenant-Name", "<tenant-name>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recordingId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"primaryLanguage\": \"en\",\n \"spokenPunctuation\": true,\n \"automaticPunctuation\": true,\n \"formatting\": {},\n \"isDictation\": true,\n \"isMultichannel\": true,\n \"diarize\": true,\n \"participants\": [\n {\n \"channel\": 1,\n \"role\": \"<string>\"\n }\n ],\n \"async\": true,\n \"replacements\": [\n {\n \"find\": \"<string>\",\n \"replace\": \"<string>\"\n }\n ],\n \"keyterms\": {\n \"terms\": [\n {\n \"term\": \"<string>\"\n }\n ]\n },\n \"wordLevel\": {\n \"enabled\": true\n }\n}")
.asString();{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"metadata": {
"participantsRoles": [
{
"channel": 1,
"role": "<string>"
}
]
},
"transcripts": [
{
"channel": 123,
"participant": 123,
"speakerId": 123,
"text": "<string>",
"start": 123,
"end": 123
}
],
"usageInfo": {
"creditsConsumed": 123
},
"recordingId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"status": "completed"
}{
"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": [
{}
]
}{
"requestid": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"validationErrors": [
{}
]
}Authorizations
Input your token
Scopes
Headers
Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.
"base"
Path Parameters
The unique identifier of the interaction. Must be a valid UUID.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Body
The unique identifier for the recording.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more.
"en"
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.
When true, automatically punctuates and capitalizes the transcript. Defaults to true. Overridden by spokenPunctuation when both are enabled.
Show child attributes
Show child attributes
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.
If true, each audio channel is transcribed separately.
If true, separates speakers within an audio channel returning incrementing ids for transcript segments.
An array of participants, each specifying a free-form role and an assigned audio channel in the recording. For raw PCM, the channel count must be defined; otherwise, the number of audio channels is resolved from the audio itself, not from the declared participants. Optional regardless of isMultichannel or diarize settings. Multiple participants may be assigned to the same channel. See audio formatting for full details.
Show child attributes
Show child attributes
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.
Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. A defined replacement can have a maximum length of 100 characters and 10-words for find and replace fields.
Show child attributes
Show child attributes
Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently.
Show child attributes
Show child attributes
When enabled, the transcript is stored and returned at word level instead of phrase/utterance level. Fixed for the lifetime of the transcript once created.
Show child attributes
Show child attributes
Response
Returns the generated transcript, including participant roles and timestamps for each utterance.
The unique identifier of the transcript.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Additional information about the participants involved in the transcript.
Show child attributes
Show child attributes
An array of transcripts.
Show child attributes
Show child attributes
Credits consumed for this request.
Show child attributes
Show child attributes
The unique identifier for the associated recording.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
The current status of the transcript processing.
completed, processing, failed Was this page helpful?