Getting Started

Step 1: Create an Account

Create a free account to gain immediate access to ElevateAI.

Free accounts have access to declare up to 1,000 interactions for processing per day. If you are interested in upgrading to a paid account, you may submit a request from the ElevateAI application or contact us directly at [email protected].



Step 2: Get Your Access Token

To enable authentication and usage tracking, an active API token associated with your account will be included in each request made to the ElevateAI API.

You are issued an API token immediately upon account creation.



To access your API token, simply navigate to the Manage Tokens Dashboard.

Document image




Step 3: Start using ElevateAI

You're now ready to transcribe, uncover CX AI insights, summarize and more with ElevateAI!

Within the Interactions resource, there are 8 different endpoints that enable you to instantly generate and retrieve insights to elevate your applications:

In general, you will need to:

  1. Declare your media: Declare an Audio Interaction, Declare a Chat Interaction or Declare a Transcript
  2. Check status: Check the Processing Status
  3. Retrieve your results once processing is complete: Get CX AI, Get Phrase-by-Phrase Transcript, Get Punctuated Transcript, ElevateAI Generative AI API calls
    1. Note: With chats and transcripts, ElevateAI Generative AI API calls do not require processing to be completed

The ElevateAI API process flow

The following diagram depicts the process flow for the various source types available within the ElevateAI API.

For most use cases the calling application should utilize a multithreaded architecture to maximize throughput.

Document image


ElevateAI API Endpoints

The following chart lists the available ElevateAI Endpoints. For most Generative AI endpoints there are two versions: CX and Generic. The CX endpoints have been listed here. For additional information on the Generic endpoints, please see Generic Gen AI Endpoints.

Method

Path

POST

https://api.elevateai.com/v1/interactions Tutorial: Declare an audio, transcript, or chat interaction for processing

POST

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/upload Tutorial: Upload a local audio file

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier} Tutorial: Retrieve declared parameters

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/status Tutorial: Retrieve the processing status

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/transcript Tutorial: Retrieve the phrase-by-phrase transcript

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/transcripts/punctuated Tutorial: Retrieve the punctuated transcript

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/ai Tutorial: Retrieve the CX AI results

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/summary Tutorial: Retrieve the Gen AI Summary

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/summary/details Tutorial: Retrieve the Gen AI Summary Details

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/agent/action-items Tutorial: Retrieve the Gen AI Action Items

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/agent/coaching-assistant Tutorial: Retrieve the Gen AI Agent Coaching Assistant

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/topics Tutorial: Retrieve the Gen AI Topics

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/conversation-composition Tutorial: Retrieve the Gen AI Conversation Composition

GET

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/ask Tutorial: Retrieve the Gen AI Ask ElevateAI

POST

https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/ask Tutorial: Submit Question to Gen AI Ask ElevateAI

DELETE

https://api.elevateai.com/v1/interactions/{interactionIdentifier} Tutorial: Delete all data

Sample Audio Files

Not a Developer?

You can process audio files and retrieve results within the ElevateAI app with no code needed.

Ready for Production?

Contact us at [email protected] to upgrade your account today!