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
Retrieve Results

Get CX AI

// Overview

Leveraging the unique interactionIdentifier provided upon successfully declaring the audio, transcript, or chat interaction, this endpoint enables you to instantly retrieve CX AI analysis outputs.

When this GET request successfully executes, an HTTP status will be returned to indicate the request was successful, along with a JSON response providing detailed CX AI output.

Sample API Response (Truncated)
|
{
  "allParticipants": {
    "enlightenBundles": [
      {
        "name": "Customer Satisfaction",
        "models": [
          {
            "name": "AcknowledgeLoyalty",
            "score": 4.169592,
            "minScore": -3.1514606,
            "minScoreOffset": 75345,
            "maxScore": 2.7370446,
            "maxScoreOffset": 196550,
            "quartile1": -4.7154593,
            "quartile2": 0.39559406,
            "quartile3": 1.9443647,
            "quartile4": 6.545092
          },
          {
            "name": "ActiveListening",
            "score": 5.8615756,
            "minScore": -1.1147503,
            "minScoreOffset": 49390,
            "maxScore": 3.5741313,
            "maxScoreOffset": 197450,
            "quartile1": -1.8281904,
            "quartile2": 0.8814685,
            "quartile3": 1.9214101,
            "quartile4": 4.8868876
          },
          ...
        ]
      }
      ...
    ],
    "voiceActivitySegments": [
        {
            "startTimeOffset": 0,
            "endTimeOffset": 1000,
            "result": "VOICE"
        },
        {
            "startTimeOffset": 1000,
            "endTimeOffset": 39000,
            "result": "SILENCE"           
        },
        ...
    ]
  },
   ... 
}


If an error occurs when requesting to declare the interaction, a standard HTTP status will be retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in troubleshooting.



// Request Parameters & Code Examples

Get AI results by ID
GET
Params
Path Params
interactionIdentifier
required
String
interactionIdentifier returned upon successfully declaring the interaction
Header Parameters
X-API-Token
required
String
Valid API key associated with your account for authentication and usage tracking
Accept-Encoding
optional
String
Recommended for bandwidth optimization, will be 'gzip, deflate, br'
Curl
Node.js
JS
Python
Ruby
C#
PHP
|
require "uri"
require "json"
require "net/http"

url = URI("https://api.elevateai.com/v1/interactions/{interctionIdentifier}/ai")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Token"] = "{Your API Token}"
request["Content-Type"] = "application/json"
request["Accept-Encoding"] = "gzip, deflate, br"

response = https.request(request)
puts response.read_body
RESPONSES
200
401
404
|
{
  "allParticipants": {
    "enlightenBundles": [
      {
        "name": "string",
        "models": [
          {
            "name": "string",
            "score": "number",
            "minScore": "number",
            "minScoreOffset": "number",
            "maxScore": "number",
            "maxScoreOffset": "number",
            "quartile1": "number",
            "quartile2": "number",
            "quartile3": "number",
            "quartile4": "number"
          }
        ]
      }
    ],
    "voiceActivitySegments": [
      {
        "startTimeOffset": "number",
        "endTimeOffset": "number",
        "result": "string"
      }
    ]
  },
  "participantOne": {
    "enlightenBundles": [
      {
        "name": "string",
        "models": [
          {
            "name": "string",
            "score": "number",
            "minScore": "number",
            "minScoreOffset": "number",
            "maxScore": "number",
            "maxScoreOffset": "number",
            "quartile1": "number",
            "quartile2": "number",
            "quartile3": "number",
            "quartile4": "number"
          }
        ]
      }
    ],
    "voiceActivitySegments": [
      {
        "startTimeOffset": "number",
        "endTimeOffset": "number",
        "result": "string"
      }
    ]
  },
  "participantTwo": {
    "enlightenBundles": [
      {
        "name": "string",
        "models": [
          {
            "name": "string",
            "score": "number",
            "minScore": "number",
            "minScoreOffset": "number",
            "maxScore": "number",
            "maxScoreOffset": "number",
            "quartile1": "number",
            "quartile2": "number",
            "quartile3": "number",
            "quartile4": "number"
          }
        ]
      }
    ],
    "voiceActivitySegments": [
      {
        "startTimeOffset": "number",
        "endTimeOffset": "number",
        "result": "string"
      }
    ]
  } 
}



// Response Schema

Schema

Element

Type

Description

{participant}

object

Top level for speaker label, identifying whether output was determined based on speech across "allParticipants", "participantOne", or "participantTwo"

{participant}/enlightenBundles

array of objects

Top level for each eligible AI behavioral model

{participant}/enlightenBundles/name

string

Name of Enlighten Bundle associated with model, will be "Customer Satisfaction" or "Vulnerable Customer"

{participant}enlightenBundles/models

array of objects

Ordered list of analysis outputs associated with each available model from bundle

{participant}/enlightenBundles/models/name

string

Name of model

{participant}/enlightenBundles/models/score

float

Overall score

{participant}/enlightenBundles/models/minScore

float

Lowest score calculated throughout interaction

{participant}/enlightenBundles/models/minScoreOffset

number

Time of lowest score calculated throughout interaction

{participant}/enlightenBundles/models/maxScore

float

Highest score calculated throughout interaction

{participant}/enlightenBundles/models/maxScoreOffset

number

Time of highest score calculated throughout interaction

{participant}/enlightenBundles/models/quartile1

float

Score calculated across first quartile of interaction

{participant}/enlightenBundles/models/quartile2

float

Score calculated across second quartile of interaction

{participant}/enlightenBundles/models/quartile3

float

Score calculated across third quartile of interaction

{participant}/enlightenBundles/models/quartile4

float

Score calculated across fourth quartile of interaction

{participant}/voiceActivitySegments

array of objects or null

Top level for each "voice" or "silence" segment

{participant}/voiceActivitySegments/startTimeOffset

number

Start time of segment

{participant}/voiceActivitySegments/endTimeOffset

number

End time of segment

{participant}/voiceActivitySegments/result

string

Type of segment, will be "voice" or "silence"



PREVIOUS
Get Punctuated Transcript
NEXT
Delete Data
Docs powered by
Archbee
Retrieve a Punctuated Transcript
TABLE OF CONTENTS
// Overview
// Request Parameters & Code Examples
GET
Retrieve a Punctuated Transcript
// Response Schema
Schema
Docs powered by
Archbee