Check the Status
Check Processing Status
7 min
// // overview leveraging the unique interactionidentifier returned upon successfully declaring the docid\ pqlj1vqo7gtf0iqj1lbvn , docid\ id41ifx7uc0rzdlb7rbto , or docid 8omp8xufyry9gab1yivul interaction enables you to instantly retrieve detailed updates on the docid\ dg0fhnxsbeeqtyd1ruqrq of your interaction analysis pro tip for best results, we recommend checking the processing status – at most – every thirty (30) seconds for an audio file and every five (5) seconds for a chat or transcription file when this get get request successfully executes, an http status is returned to indicate the request was successful, along with a json response providing details around the docid\ dg0fhnxsbeeqtyd1ruqrq of your interaction if an error occurs when requesting the status, a standard http response code is retuned to indicate the request was unsuccessful, along with a json response containing additional details to https //docs elevateai com/#qofti sample api response { "identifier" "bd5c92f3 c228 44a6 91bf b52672569878", "status" "processed", "declared" "2022 06 17t21 23 06 137087z", "uploaded" null, "downloaded" "2022 06 17t21 24 53 639208z", "processed" "2022 06 17t21 29 05 071z", "errormessage" null } you are only able to retrieve the docid\ lb05bq 53xeiiwv5lxi9k , the docid\ lubknfsfjj9za79mm kdn , or the docid 05ydve34wjax0rfhfwdxm associated with the interaction once the status indicates the interaction has been processed note only processed interactions will generate applicable usage billing please refer to the docid\ o6bp0qg51jaz8zkuwm3ih for more information // // request parameters & code example { "tab" "examples", "url" "https //api elevateai com/v1/interactions/{interactionidentifier}/status", "name" "retrieve processing status", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "interactionidentifier", "type" "string", "description" "interactionidentifier 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" "z4ojaichyk2u3vesn0hc ", "code" "{\n \\"identifier\\" \\"string\\",\n \\"status\\" \\"string\\",\n \\"declared\\" \\"string\\",\n \\"uploaded\\" \\"string\\",\n \\"downloaded\\" \\"string\\",\n \\"processed\\" \\"string\\",\n \\"errormessage\\" \\"string\\"\n}", "language" "200", "customlabel" "" }, { "id" "6qttbzwcfezjoynvekz7j", "code" "{\r\n \\"errormessage (string)\\"\r\n}", "language" "401", "customlabel" "" }, { "id" "ked3nzp5ycf niv5wbk6l", "code" "{\r\n \\"errormessage (string)\\"\r\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "z4ojaichyk2u3vesn0hc " }, "examples" { "languages" \[ { "id" " f8vjrve5qr1ehri7egt1", "code" "curl location g request get 'https //api elevateai com/v1/interactions/{interactionidentifier}/status' \\\\\r\n header 'accept encoding gzip, deflate, br' \\\\\r\n header 'x api token {your api token}'", "language" "curl", "customlabel" "" }, { "id" "deapx aaetiuwvokmpy11", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api elevateai com/v1/interactions/{interactionidentifier}/status',\n 'headers' {\n 'accept encoding' 'gzip, deflate, br',\n 'x api token' '{your api token}'\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" "eiktqefamywmexzs4shla", "code" "var myheaders = new headers();\nmyheaders append(\\"accept encoding\\", \\"gzip, deflate, br\\");\nmyheaders append(\\"x api token\\", \\"{your api token}\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "p xg2nohxjy2ndoio acd", "code" "import http client\n\nconn = http client httpsconnection(\\"api elevateai com\\")\npayload = ''\nheaders = {\n 'accept encoding' 'gzip, deflate, br',\n 'x api token' '{your api token}'\n}\nconn request(\\"get\\", \\"/v1/interactions/{interactionidentifier}/status\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "language" "python", "customlabel" "" }, { "id" "idp5imx79uq9r qrj2mq", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept encoding\\"] = \\"gzip, deflate, br\\"\nrequest\[\\"x api token\\"] = \\"{your api token}\\"\n\nresponse = https request(request)\nputs response read body", "language" "ruby", "customlabel" "" }, { "id" "2y5xmpju8g4wa6f7 5bfx", "code" "var client = new restclient(\\"https //api elevateai com/v1/interactions/{interactionidentifier}/status\\");\r\nclient timeout = 1;\r\nvar request = new restrequest(method get);\r\nrequest addheader(\\"accept encoding\\", \\"gzip, deflate, br\\");\r\nrequest addheader(\\"x api token\\", \\"{your api token}\\");\r\nirestresponse response = client execute(request);\r\nconsole writeline(response content);", "language" "csharp", "customlabel" "" }, { "id" "9yenfgm1ow7amvejkarpz", "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/%7binteractionidentifier%7d/status',\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 'accept encoding gzip, deflate, br',\r\n 'x api token {your api token}'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;", "language" "php", "customlabel" "" } ], "selectedlanguageid" "p xg2nohxjy2ndoio acd" }, "description" "", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "autogeneratedanchorslug" "retrieve processing status", "legacyhash" "9cazmkqbdbgyqsl4om7d " } // // response schema schema 122,67,554 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 note all source data has been deleted once check processing status docid\ dg0fhnxsbeeqtyd1ruqrq indicates either processed or processingfailed status definitions 165,578 true left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type need more help? contact the mailto\ support\@elevateai com