website logo
System StatusChange LogLog In / Sign Up
Reference
Tutorials
Navigate through spaces
Reference
Tutorials
⌘K
Overview
Transcription Features
CX AI Features
Getting Started
ElevateAI Dashboards
Submit an Interaction
Declare an Audio Interaction
Declare a Transcript
Declare a Chat Interaction
Check the Status
Check the Processing Status
Retrieve Declared Parameters
Retrieve Results
Get Phrase-by-Phrase Transcript
Get Punctuated Transcript
Get CX AI
Delete Data
Python SDK
.Net SDK
Docs powered by archbee 

Declare an Audio Interaction

// Overview

The first step in processing any interaction is to declare the interaction.

When the 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
|


It is important you store the interactionIdentifier as it will serve as a required parameter for all other ElevateAI endpoints, enabling you to POST, GET, and/or 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.

All interactions successfully declared will count towards your monthly 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 of the interaction as well as track impacts to usage and spend.



// Request Parameters & Code Examples

POST
Params
Header Parameters
X-API-Token
required
String
Valid API key associated with your account for authentication and usage tracking
Content-Type
required
String
Will be 'application/JSON'
Body Parameters
type
required
String
Type of interaction to be processed, will be "audio"
languageTag
required
String
Primary language of the audio file, will be: "en-us" (for North American English), "en" (for International English), or "es-419" (for North American Spanish)
vertical
required
String
Vertical associated with interaction, will be "default"
audioTranscriptionMode
required
String
Desired transcription prioritization, will be "highSpeed" or "highAccuracy"
downloadUri
optional
String
The URL of your audio file Important: Do not include the downloadUri parameter if you wish to upload a local audio file; an empty string will cause the download to fail
includeAiResults
optional
Boolean
Include AI results, will be 'true' or 'false' (default)
Curl
Node.js
JS
Python
Ruby
C#
PHP
|
RESPONSES
201
400
401
429
|


Details on transcription and CX AI features supported by language can be found on the overview page.



// Submitting an Audio File for Processing

Download URL

Providing access to audio files via the downloadUri parameter is highly recommended for fastest processing times.

We take data security seriously, and know you do to! If required, we are able to provide an IP address to support IP whitelisting or assist in setting up a private, secure SFTP to support transferring via SFTP with URL format. If you have any questions on how to transfer your audio, reach out at any time to support@elevateai.com - we're here to help!

SFTP Transfer

If transferring via SFTP, you will specify a path that represents a directory with the downloadUri formatted like "sftp://[user:password@]host[:port]/~/path/;type=d"

Example where 'filename.wav' resides in the logged in user's home directory
|


Local File

If the downloadUri parameter is not included when declaring the interaction, the audio should be uploaded to the API directly for processing.

UP NEXT
Upload an Audio File
Docs powered by archbee 
Declare an Interaction for Processing (Audio)
TABLE OF CONTENTS
// Overview
// Request Parameters & Code Examples
POST
Declare an Interaction for Processing (Audio)
// Submitting an Audio File for Processing
Download URL
SFTP Transfer
Local File