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.
{
"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
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"))// 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 |
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 |