Getting Started
// Step 1: Create an Account
Create a free account to gain immediate access to NiCE ElevateAI.
Through our new Fast Start program, free accounts have access to declare up to 10 interactions for processing per day!
If you are interested in upgrading to a paid account:
- Submit a request within the ElevateAI application
- Contact us directly at [email protected] for help
// 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.
// Step 3: Start using ElevateAI
You're now ready to use ElevateAI to generate transcriptions, uncover CX AI insights, create AutoSummaries, query your data with Ask ElevateAI Q&A, and more!
Within the Interactions resource, there are eight (8) different endpoints that let you generate and retrieve insights instantly to power your applications:
Workflow Overview
Declare your interaction media: audio, chat or transcript
Check processing statusCheck Your Processing Status
Retrieve results once processing is complete:
- Get CX AI InsightsGet CX AI
NOTE: For chat and transcript interactions, ElevateAI Generative AI API callsElevateAI Generative AI API calls do not require processing to be completed before retrieval.
// API Process Flow
The diagram below illustrates the ElevateAI API process workflow across the different supported source types.
NOTE: For most use cases, we recommend a multi-threaded architecture in the calling application to maximize throughput.
// ElevateAI API Endpoints
The following chart lists the available ElevateAI API Endpoints.
For most Generative AI endpoints, there are two versions: CX and Generic.
The CX Endpoints have been listed below; for additional information on the Generic Endpoints, please see Generic GenAI Endpoints.
Method | Path |
|---|---|
POST | https://api.elevateai.com/v1/interactions Tutorial: Declare an interaction for processing via audio, transcript, or chat |
POST | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/upload Tutorial: Upload an Audio File |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier} Tutorial: Retrieve Declared Parameters |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/status Tutorial: Check Processing Status |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/transcript Tutorial: Retrieve Phrase-by-Phrase Transcript |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/transcripts/punctuated Tutorial: Retrieve 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 GenAI Summary Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/summary/details Tutorial: AutoSummary Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/agent/action-items Tutorial: Agent Action Item Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/agent/coaching-assistant Tutorial: Agent Coaching Assistant Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/topics Tutorial: Generative AI API Endpoint Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/conversation-composition Tutorial: Conversation Composition Details |
GET | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/ask Tutorial: Retrieve Ask ElevateAI Q&A Details |
POST | https://api.elevateai.com/v1/interactions/{interactionIdentifier}/gen-ai/cx/ask Tutorial: Submit Question to Ask ElevateAI Q&A |
DELETE | https://api.elevateai.com/v1/interactions/{interactionIdentifier} Tutorial: Delete Data |
// Sample Audio Files
Not a Developer? You can process audio files and retrieve results within the ElevateAI app with our No-Code Dashboard, no coding knowledge required!
Contact our Sales & Partnerships team to upgrade your account today!
Need more help? Contact the ElevateAI Support team.