Submit an Interaction
Declare an Audio Interaction
8min
// // overview the first step in processing any interaction is to declare the interaction when the post post request successfully executes, an http status is returned to indicate the request was successful, along with a json response containing the interactionidentifier sample api response { "interactionidentifier" "2ebaffd6 7a4b 4bcf a169 678af0705779" } it is important you store the interactionidentifier as it will serve as a required parameter for all other elevateai endpoints, enabling you to post post , get get , and/or delete delete information associated with this interaction 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 troubleshooting all interactions successfully declared will count towards your monthly request quota request quota , irrespective of file upload status or processing outcome only interactions successfully processed are eligible for billing once declared, you can confirm the processing status https //docs elevateai com/tutorials/check the processing status of the interaction as well as track impacts to usage https //docs elevateai com/tutorials/elevateai dashboards#h1qyd and spend https //docs elevateai com/tutorials/elevateai dashboards#jysvi echo echo introducing echo , our most accurate transcription model ever! echo delivers a significant leap in accuracy , outperforming our previous cx focused model by 40%, ensuring superior transcription quality across every use case to take advantage of the echo model, add the body parameter "model" to your post declare and set the value to "echo" note currently the echo model does not perform redaction future releases will continue to move echo towards feature parity with elevateai's cx transcription model feature updates can be seen via our release notes // // request parameters & code examples details on transcription and cx ai features supported by language can be found on the overview page https //docs elevateai com/overview#bgq4z // // submitting an audio file for processing download uri providing access to audio files via the downloaduri parameter is highly recommended for fastest processing times processing times when using the download uri option, authentication parameters can be included in the declare for source systems which require it see body parameters above local file if the downloaduri parameter is not included when declaring the interaction, the audio should be uploaded to the api directly https //docs elevateai com/tutorials/upload an audio file for processing // // submitting metadata metadata must only be submitted with an api token for an account which has explore enabled use under other circumstances will cause the declare to fail, and a response of 400 bad request for details on the types and formatting of metadata, please see metadata https //docs elevateai com/tutorials/metadata