Retrieve Results
Get Punctuated Transcripts
5 min
// // overview leveraging the unique interactionidentifier provided upon successfully docid\ pqlj1vqo7gtf0iqj1lbvn , the punctuated transcript endpoint lets you instantly retrieve a detailed sentence by sentence transcript with precise timings , docid\ zatcqmnsvapzs9wwkgecn , and https //docs elevateai com/transcription features#fdlgr when this get get request successfully executes, an http status will be returned to indicate the request was successful, along with a json response providing https //docs elevateai com/tutorials/get punctuated transcript#jwy9 sample api response (truncated) { "sentencesegments" \[ { "participant" "participantone", "starttimeoffset" 1410, "endtimeoffset" 3210, "phrase" "thank you for calling america phone service ", "score" 0 99137425 }, { "participant" "participantone", "starttimeoffset" 3210, "endtimeoffset" 5570, "phrase" "this is adam speaking, how may i be of service ", "score" 0 99325925 }, ], "redactionsegments" \[ { "starttimeoffset" 24650, "endtimeoffset" 27530, "result" "cvv", "score" 0 }, ] } if an error occurs when requesting to declare the interaction, a standard http status will be retuned to indicate the request was unsuccessful, along with a json response containing additional details to https //docs elevateai com/#qofti // // request parameters & code examples { "tab" "examples", "url" "https //api elevateai com/v1/interactions/{interactionidentifier}/transcripts/punctuated", "name" "retrieve a punctuated transcript", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "interactionidentifier", "type" "string", "description" "interactionidentifier (guid) returned upon successfully declaring the interaction" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api token", "type" "string", "description" "valid api key associated with your account for authentication and usage tracking" }, { "kind" "optional", "name" "accept encoding", "type" "string", "description" "recommended for bandwidth optimization, will be 'gzip, deflate, br'" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "wov v6skqlwseavef84vd", "code" "{\n\t\\"sentencesegments\\" \[{\n\t\t\\"participant\\" \\"string\\",\n\t\t\\"starttimeoffset\\" \\"number\\",\n\t\t\\"endtimeoffset\\" \\"number\\",\n\t\t\\"phrase\\" \\"string\\",\n\t\t\\"score\\" \\"number\\"\n\t}],\n\t\\"redactionsegments\\" \[{\n\t\t\\"starttimeoffset\\" \\"number\\",\n\t\t\\"endtimeoffset\\" \\"number\\",\n\t\t\\"result\\" \\"string\\",\n\t\t\\"score\\" \\"number\\"\n\t}]\n}", "language" "200", "customlabel" "" }, { "id" "ug7elqbvg6nz1glvftnze", "code" "{\n \\"statuscode\\" httpstatuscode\n}", "language" "204", "customlabel" "" }, { "id" "ypthsxrc k8r4z ys8dyf", "code" "{\n \\"errormessage\\" \\"string\\"\n}", "language" "401", "customlabel" "" }, { "id" "cnnwssw8rcabnp3vrvm75", "code" "{\r\n \\"errormessage\\" \\"string\\"\r\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "ug7elqbvg6nz1glvftnze" }, "examples" { "languages" \[ { "id" "mvypojsomedfbiykydzmk", "code" "curl location g request get 'https //api elevateai com/v1/interactions/{interctionidentifier}/transcripts/punctuated' \\\\\n header 'x api token {your api token}' \\\\\n header 'content type application/json' \\\\\n header 'accept encoding gzip, deflate, br'", "language" "curl", "customlabel" "" }, { "id" "yv chbnqxb5bvb1s8bran", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api elevateai com/v1/interactions/{interctionidentifier}/transcripts/punctuated',\n 'headers' {\n 'x api token' '{your api token}',\n 'content type' 'application/json',\n 'accept encoding' 'gzip, deflate, br'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "xogqasie93pggzimhomxf", "code" "var myheaders = new headers();\nmyheaders append(\\"x api token\\", \\"{your api token}\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"accept encoding\\", \\"gzip, deflate, br\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api elevateai com/v1/interactions/{interctionidentifier}/transcripts/punctuated\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "slhowhviy8rm3cgzizyop", "code" "import http client\nimport json\n\nconn = http client httpsconnection(\\"api elevateai com\\")\npayload = ''\nheaders = {\n 'x api token' '{your api token}',\n 'content type' 'application/json',\n 'accept encoding' 'gzip, deflate, br'\n}\nconn request(\\"get\\", \\"/v1/interactions/{interctionidentifier}/transcripts/punctuated\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "language" "python", "customlabel" "" }, { "id" "mwbl7qxk3ml nottihixq", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api elevateai com/v1/interactions/{interctionidentifier}/transcripts/punctuated\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"x api token\\"] = \\"{your api token}\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"accept encoding\\"] = \\"gzip, deflate, br\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" }, { "id" "fayd9qeajkdhufwarb0g0", "code" "var client = new restclient(\\"https //api elevateai com/v1/interactions/{interctionidentifier}/transcripts/punctuated\\");\r\nclient timeout = 1;\r\nvar request = new restrequest(method get);\r\nrequest addheader(\\"x api token\\", \\"{your api token}\\");\r\nrequest addheader(\\"content type\\", \\"application/json\\");\r\nrequest addheader(\\"accept encoding\\", \\"gzip, deflate, br\\");\r\nirestresponse response = client execute(request);\r\nconsole writeline(response content);", "language" "csharp", "customlabel" "" }, { "id" "yh0ejy8yazogvvyk8gysd", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api elevateai com/v1/interactions/%7binterctionidentifier%7d/transcripts/punctuated',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api token {your api token}',\r\n 'content type application/json',\r\n 'accept encoding gzip, deflate, br'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php", "customlabel" "" } ], "selectedlanguageid" "fayd9qeajkdhufwarb0g0" }, "description" "get a transcript by its id", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "autogeneratedanchorslug" "retrieve a punctuated transcript", "legacyhash" "tyrxqywmg8ydyhgurj0ex" } // // response schema schema 280,109,354 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type need more help? contact the mailto\ support\@elevateai com