Getting Started
10 min
// // step 1 create an account create a free account https //app elevateai com/auth/signup to gain immediate access to nice elevateai through our new fast start program https //docs elevateai com/? gl=1 mlnm4g gcl au mtc1ntkzoda0oc4xnzuyodcyndu2 ga otm5mjy0mjq0lje3nti4njg0nzk ga cvlq99c4b6 cze3ntkzmzm3otkkbzy0jgcxjhqxnzu5mzm0mtg2jgo2mcrsmcroma #iwwly , free accounts have access to declare up to 10 interactions for processing per day ! if you are interested in upgrading to a paid account https //docs elevateai com/? gl=1 mlnm4g gcl au mtc1ntkzoda0oc4xnzuyodcyndu2 ga otm5mjy0mjq0lje3nti4njg0nzk ga cvlq99c4b6 cze3ntkzmzm3otkkbzy0jgcxjhqxnzu5mzm0mtg2jgo2mcrsmcroma #iwwly submit a request https //app elevateai com/upgradeaccount within the elevateai application contact us directly at sales\@elevateai com mailto\ sales\@elevateai com for help // // step 2 get your access token to enable authentication https //docs elevateai com/#n3e6e and usage tracking https //docs elevateai com/tutorials/elevateai dashboards# xqwv , 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 https //docs elevateai com/tutorials/elevateai dashboards# xqwv immediately upon account creation to access your api token, simply navigate to the manage tokens dashboard https //docs elevateai com/tutorials/elevateai dashboards# xqwv // // 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 docid\ pqlj1vqo7gtf0iqj1lbvn , chat docid\ id41ifx7uc0rzdlb7rbto or transcript docid 8omp8xufyry9gab1yivul check processing status docid\ dg0fhnxsbeeqtyd1ruqrq retrieve results once processing is complete get cx ai insights docid 05ydve34wjax0rfhfwdxm get phrase by phrase transcripts docid\ lb05bq 53xeiiwv5lxi9k get punctuated transcripts docid\ etigrcbkicbunyr5t0ryg elevateai generative ai api calls docid\ y mpgjlgd3oo9voazv562 note for chat and transcript interactions , elevateai generative ai api calls docid\ y mpgjlgd3oo9voazv562 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 https //docs elevateai com/tutorials/generative ai api endpoint details#cf4 q method path post post https //api elevateai com/v1/interactions tutorial declare an interaction for processing via declare an interaction for processing via audio docid\ pqlj1vqo7gtf0iqj1lbvn , transcript docid 8omp8xufyry9gab1yivul , or or chat docid\ id41ifx7uc0rzdlb7rbto post post https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/upload tutorial upload an audio file docid\ xpi3og0 qaqt0tnvxrrth get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier } tutorial retrieve declared parameters docid\ m4rtu1uf1ii3knqymogvw get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/status tutorial check processing status docid\ dg0fhnxsbeeqtyd1ruqrq get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/transcript tutorial retrieve phrase by phrase transcript docid\ lb05bq 53xeiiwv5lxi9k get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/transcripts/punctuated tutorial retrieve punctuated transcript docid\ etigrcbkicbunyr5t0ryg get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/ai tutorial retrieve the cx ai results docid 05ydve34wjax0rfhfwdxm get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/summary tutorial retrieve genai summary details docid\ py9qfijqtud9wpoxefk6h get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/summary/details tutorial autosummary details docid\ py9qfijqtud9wpoxefk6h get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/agent/action items tutorial agent action item details docid\ m7hvxdu1jgbcywecdjs7f get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/agent/coaching assistant tutorial agent coaching assistant details docid\ iz0l4zghuyavqt8eoko5e get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/topics tutorial generative ai api endpoint details docid\ ol6 woanmvfyubwezq8rp get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/conversation composition tutorial conversation composition details docid\ gtea9zncsde9x6kuf617r get get https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/ask tutorial retrieve ask elevateai q\&a details docid 1i0wcohmqtq17c6tnvano post post https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier }/gen ai/cx/ask tutorial submit question to ask elevateai q\&a docid 4jblvbxqcii7um6vr1nzh delete delete https //api elevateai com/v1/interactions/{ interactionidentifier interactionidentifier } tutorial delete data docid\ y 2 7nfl0uauue05mjsx0 // // sample audio files not a developer? you can process audio files and retrieve results within the elevateai app with our no code dashboard https //docs elevateai com/tutorials/elevateai dashboards#rvou , no coding knowledge required! contact our sales & partnerships team https //docs elevateai com/#4zatw to upgrade your account today! need more help? contact the elevateai support team mailto\ support\@elevateai com