Getting Started
10 min
// // 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 sales\@elevateai com 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 declare an audio interaction , declare a chat interaction or declare a transcript check the processing status retrieve results once processing is complete get cx ai get phrase by phrase transcript get punctuated transcript elevateai generative ai api calls note for chat and transcript interactions , elevateai 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 post https //api elevateai com/v1/interactions tutorial declare an interaction for processing via declare an interaction for processing via declare an audio interaction , declare a transcript , or or declare a chat interaction post post https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/upload tutorial upload an audio file get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier } tutorial retrieve declared parameters get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/status tutorial check the processing status get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/transcript tutorial get phrase by phrase transcript get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/transcripts/punctuated tutorial get punctuated transcript get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/ai tutorial get cx ai get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/summary tutorial summary details get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/summary/details tutorial summary details get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/agent/action items tutorial agent action items get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/agent/coaching assistant tutorial agent coaching assistant get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/topics tutorial generative ai api endpoint details get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/conversation composition tutorial conversation composition get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/ask tutorial ask retrieve responses post post https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/ask tutorial ask delete delete https //api elevateai com/v1/interactions/{ interactionidentifier 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