Check the Status

Retrieve Declared Parameters

﻿//  Overview 
Leveraging the unique interactionIdentifier provided upon successfully declaring the ﻿audio﻿, ﻿transcript﻿, or ﻿chat﻿ interaction, this endpoint enables you to instantly retrieve the parameters declared when submitting the interaction for processing.
When this GET request successfully executes, an HTTP status will be returned to indicate the request was successful, along with a JSON response outlining the ﻿declared parameters﻿ for the given interactionIdentifier.
Sample API Response
|
{
    "identifier": "a3c1c9b5-5371-472c-97c1-538b369ff149",
    "type": "audio",
    "languageTag": "en-US",
    "vertical": "default",
    "audioTranscriptionMode": "highSpeed",
    "transcript": null,
    "chat": null,
    "downloadUri": null,
    "includeAiResults": true
}
{
    "identifier": "a3c1c9b5-5371-472c-97c1-538b369ff149",
    "type": "audio",
    "languageTag": "en-US",
    "vertical": "default",
    "audioTranscriptionMode": "highSpeed",
    "transcript": null,
    "chat": null,
    "downloadUri": null,
    "includeAiResults": true
}
﻿
If an error occurs when requesting to declare the interaction, a standard HTTP response code is retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in ﻿troubleshooting﻿. 
﻿
﻿//  Request Parameters & Code Example
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
|
import http.client

conn = http.client.HTTPSConnection("api.elevateai.com")
payload = ''
headers = {
  'Accept-Encoding': 'gzip, deflate, br',
  'X-API-Token': '{Your API Token}'
}
conn.request("GET", "/v1/interactions/{InteractionIdentifier}", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import http.client

conn = http.client.HTTPSConnection("api.elevateai.com")
payload = ''
headers = {
  'Accept-Encoding': 'gzip, deflate, br',
  'X-API-Token': '{Your API Token}'
}
conn.request("GET", "/v1/interactions/{InteractionIdentifier}", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
RESPONSES
200
401
404
|
{
    "identifier": "string",
    "type": "string",
    "languageTag": "string",
    "vertical": "string",
    "audioTranscriptionMode": "string",
    "transcript": null,
    "chat": null,
    "downloadUri": "string",
    "includeAiResults": boolean
}

{
    "identifier": "string",
    "type": "string",
    "languageTag": "string",
    "vertical": "string",
    "audioTranscriptionMode": "string",
    "transcript": null,
    "chat": null,
    "downloadUri": "string",
    "includeAiResults": boolean
}
﻿
﻿
﻿//  Response Schema
Schema
Element
Type
Description
identifier
string
Unique interactionIdentifier associated with the request
type
string
Type of interaction, will be "audio", "transcript", or "chat"
languageTag
string
Primary language of the file, will be "en-us" (for North American English), "en" (for International English), or "es-419" (for North American Spanish)
vertical
string
Vertical associated with interaction, will be "default"
audioTranscriptionMode
string or null
If applicable, desired transcription prioritization, will be "highSpeed" or "highAccuracy"
transcript
null
Uploaded transcripts are deleted upon processing
chat
null
Uploaded chats are deleted upon processing
downloadUri
string or null
URL of audio file, if applicable
includeAiResults
string
Include AI results, will be true or false
﻿

Check the Processing Status

Get Phrase-by-Phrase Transcript

Docs powered by

Archbee

TABLE OF CONTENTS

// Overview

// Request Parameters & Code Example

GET

Retrieve Declared Parameters

// Response Schema

Schema

Element	Type	Description
identifier	string	Unique interactionIdentifier associated with the request
type	string	Type of interaction, will be "audio", "transcript", or "chat"
languageTag	string	Primary language of the file, will be "en-us" (for North American English), "en" (for International English), or "es-419" (for North American Spanish)
vertical	string	Vertical associated with interaction, will be "default"
audioTranscriptionMode	string or null	If applicable, desired transcription prioritization, will be "highSpeed" or "highAccuracy"
transcript	null	Uploaded transcripts are deleted upon processing
chat	null	Uploaded chats are deleted upon processing
downloadUri	string or null	URL of audio file, if applicable
includeAiResults	string	Include AI results, will be true or false

Retrieve Declared Parameters

﻿// Overview

﻿// Request Parameters & Code Example

﻿// Response Schema

Schema

// Overview

// Request Parameters & Code Example

// Response Schema