Website logo
System StatusChange LogLog In / Sign Up
Reference
Tutorials
Navigate through spaces
⌘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
.Net SDK
Python SDK
Java SDK
Docs powered by Archbee
Submit an Interaction
Declare an Audio Interaction

Upload an Audio File

// Overview

Leveraging the unique interactionIdentifier provided upon successfully declaring the audio interaction, this endpoint enables you to upload a valid audio for processing directly from the host machine as a multipart/form-data request.

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

When this POST request successfully executes, an HTTP status is returned to indicate the request was successful and the file is in the process of being uploaded by the Service.

If an error occurs when requesting to upload 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.

Remember: You can easily retrieve the processing status of your interaction at any time!



// 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
Form Parameters
filename.{extension}
required
String
Parameter name will include the file type extension (example: 'filename.wav') with key providing path to local file
Curl
Node.js
JS
Python
Ruby
C#
PHP
var request = require('request');
var fs = require('fs');
var path = require('path');

var filepath = '/path/to/file'

var options = {
  'method': 'POST',
  'url': 'https://api.elevateai.com/v1/interactions/{interactionIdentifier}/upload',
  'headers': {
    'X-API-Token': '{Your-API-Token}'
  },
  formData: {
    'filename.wav': {
      'value': fs.createReadStream(filepath),
      'options': {
        'filename': path.parse(filepath).base,
        'contentType': null
      }
    }
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
Responses
201
400
401
409
413





PREVIOUS
Metadata
NEXT
Declare a Transcript
Docs powered by Archbee
TABLE OF CONTENTS
// Overview
// Request Parameters & Code Examples
POST
Upload an Interaction (Audio)
Docs powered by Archbee