Retrieve Declared Parameters

// // overview leveraging the unique interactionidentifier provided upon successfully declaring the audio https //docs elevateai com/tutorials/declare an audio interaction , transcript https //docs elevateai com/tutorials/declare a transcript , or chat https //docs elevateai com/tutorials/declare a chat interaction interaction, this endpoint enables you to instantly retrieve the parameters declared when submitting the interaction for processing when this get get request successfully executes, an http status will be returned to indicate the request was successful, along with a json response outlining the declared parameters for the given interactionidentifier sample api response { "identifier" "a3c1c9b5 5371 472c 97c1 538b369ff149", "type" "audio", "languagetag" "en us", "vertical" "default", "audiotranscriptionmode" "highspeed", "transcript" null, "chat" null, "downloaduri" null, "includeairesults" true } if an error occurs when requesting to declare the interaction, a standard http response code is retuned to indicate the request was unsuccessful, along with a json response containing additional details to assist in troubleshooting // // request parameters & code example tab examples url https api elevateai com v1 interactions interactionidentifier name retrieve declared parameters 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 type string n languagetag string n vertical string n audiotranscriptionmode string n transcript null n chat null n downloaduri string n includeairesults boolean n 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 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 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 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 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 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 3tcl1zgauq7qj9qii khj code var client new restclient https api elevateai com v1 interactions interactionidentifier ; 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 evrtg2awjtsb3qhrkf5zp 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 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; r n language php customlabel selectedlanguageid p xg2nohxjy2ndoio acd description currentnewparameter label header parameter value headerparameters // // response schema schema element type description identifier string unique interactionidentifier associated with the request type string type of interaction, will be audio , transcript , or chat languagetag string primary language of the file, will be en us for north american english, en for international english, or es 419 for north american spanish vertical string vertical associated with interaction, will be default audiotranscriptionmode string or null if applicable, desired transcription prioritization, will be highspeed or highaccuracy transcript null uploaded transcripts are deleted upon processing chat null uploaded chats are deleted upon processing downloaduri string or null url of audio file, if applicable includeairesults string include ai results, will be true or false