Skip to main content
API docs by Redocly

Speechlytics API (v1)

Download OpenAPI specification:Download

Auth

Create a new authentication token

This endpoint allows users to create a new authentication token by providing their username and password. The token can be used for subsequent API requests.

Authorizations:
Bearer
Request Body schema:
username
string or null
password
string or null

Responses

Request samples

Content type
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
No sample

Health

Check the health of the server

This endpoint checks the health of the server and returns a status indicating whether the server is operational. It can be used to monitor the server's availability.

Authorizations:
Bearer

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/health"

Response samples

Content type
No sample

Insights

Get insights data

This endpoint retrieves analytics data based on the provided parameters such as page, rows, date range, etc. It returns a paginated list of analytics records.

Authorizations:
Bearer
query Parameters
Page
integer <int32>
Rows
integer <int32> [ 0 .. 100 ]
DateFrom
string
DateTo
string

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/insights?Page=123&Rows=123&DateFrom=sample&DateTo=sample"

Get a list of topics

This endpoint retrieves a list of topics that can be used for categorizing calls. It returns a list of available topics.

Authorizations:
Bearer

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/insights/topics"

Get a list of sentiments

This endpoint retrieves a list of sentiments that can be used for analyzing the emotional tone of calls. It returns a list of available sentiments.

Authorizations:
Bearer

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/insights/sentiments"

Live Transcribe

Start live transcribe

This endpoint starts live transcription for a given audio stream. It requires parameters such as the name, number of channels, language, and user details to initiate the transcription process.

Authorizations:
Bearer
Request Body schema:
name
string or null
numberOfChannels
integer <int32>
language
integer <int32> (Language)
Enum: "0 - Auto" "1 - ENGLISH" "2 - CHINESE" "3 - GERMAN" "4 - SPANISH" "5 - RUSSIAN" "6 - KOREAN" "7 - FRENCH" "8 - JAPANESE" "9 - PORTUGUESE" "10 - TURKISH" "11 - POLISH" "12 - DUTCH" "13 - ARABIC" "14 - SWEDISH" "15 - ITALIAN" "16 - INDONESIAN" "17 - HINDI" "18 - FINNISH" "19 - VIETNAMESE" "20 - HEBREW" "21 - UKRAINIAN" "22 - GREEK" "23 - CZECH" "24 - ROMANIAN" "25 - DANISH" "26 - HUNGARIAN" "27 - NORWEGIAN" "28 - CROATIAN" "29 - BULGARIAN" "30 - LITHUANIAN" "31 - LATIN" "32 - SLOVAK" "33 - LATVIAN" "34 - SERBIAN" "35 - SLOVENIAN" "36 - KANNADA" "37 - ESTONIAN" "38 - MACEDONIAN" "39 - ICELANDIC" "40 - ARMENIAN" "41 - BOSNIAN" "42 - ALBANIAN" "43 - BELARUSIAN" "44 - LUXEMBOURGISH" "45 - TAMIL" "46 - CATALAN" "47 - MALAY" "48 - THAI" "49 - URDU" "50 - MAORI" "51 - MALAYALAM" "52 - WELSH" "53 - TELUGU" "54 - PERSIAN" "55 - BENGALI" "56 - AZERBAIJANI" "57 - BRETON" "58 - BASQUE" "59 - NEPALI" "60 - MONGOLIAN" "61 - KAZAKH" "62 - SWAHILI" "63 - GALICIAN" "64 - MARATHI" "65 - PUNJABI" "66 - SINHALA" "67 - KHMER" "68 - SHONA" "69 - YORUBA" "70 - SOMALI" "71 - AFRIKAANS" "72 - OCCITAN" "73 - GEORGIAN" "74 - TAJIK" "75 - SINDHI" "76 - GUJARATI" "77 - AMHARIC" "78 - YIDDISH" "79 - LAO" "80 - UZBEK" "81 - FAROESE" "82 - HAITIANCREOLE" "83 - PASHTO" "84 - TURKMEN" "85 - NYNORSK" "86 - MALTESE" "87 - SANSKRIT" "88 - MYANMAR" "89 - TIBETAN" "90 - TAGALOG" "91 - MALAGASY" "92 - ASSAMESE" "93 - TATAR" "94 - HAWAIIAN" "95 - LINGALA" "96 - HAUSA" "97 - BASHKIR" "98 - JAVANESE" "99 - SUNDANESE" "100 - CANTONESE"
username
string or null
local
string or null
remote
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "numberOfChannels": 0,
  • "language": "0 - Auto",
  • "username": "string",
  • "local": "string",
  • "remote": "string"
}

Response samples

Content type
No sample

Stop live transcribe

This endpoint stops the live transcription process for a given ID. It requires the ID of the transcription session to be stopped.

Authorizations:
Bearer
Request Body schema:
id
integer <int64>

Responses

Request samples

Content type
{
  • "id": 0
}

Response samples

Content type
No sample

Get Payload for live transcribe

This endpoint return payload for ongoing transcript for a given ID.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/live-transcribe/123/payload"

Response samples

Content type
No sample

Transcribe

Transcribe audio for speech analytics

This endpoint Transcribe audio data for speech analytics. It requires parameters such as the audio data in base64 format, filename, language, metadata, and options for priority and filename existence check.

Authorizations:
Bearer
Request Body schema:
dataBase64
string or null
filename
string or null
language
integer <int32> (Language)
Enum: "0 - Auto" "1 - ENGLISH" "2 - CHINESE" "3 - GERMAN" "4 - SPANISH" "5 - RUSSIAN" "6 - KOREAN" "7 - FRENCH" "8 - JAPANESE" "9 - PORTUGUESE" "10 - TURKISH" "11 - POLISH" "12 - DUTCH" "13 - ARABIC" "14 - SWEDISH" "15 - ITALIAN" "16 - INDONESIAN" "17 - HINDI" "18 - FINNISH" "19 - VIETNAMESE" "20 - HEBREW" "21 - UKRAINIAN" "22 - GREEK" "23 - CZECH" "24 - ROMANIAN" "25 - DANISH" "26 - HUNGARIAN" "27 - NORWEGIAN" "28 - CROATIAN" "29 - BULGARIAN" "30 - LITHUANIAN" "31 - LATIN" "32 - SLOVAK" "33 - LATVIAN" "34 - SERBIAN" "35 - SLOVENIAN" "36 - KANNADA" "37 - ESTONIAN" "38 - MACEDONIAN" "39 - ICELANDIC" "40 - ARMENIAN" "41 - BOSNIAN" "42 - ALBANIAN" "43 - BELARUSIAN" "44 - LUXEMBOURGISH" "45 - TAMIL" "46 - CATALAN" "47 - MALAY" "48 - THAI" "49 - URDU" "50 - MAORI" "51 - MALAYALAM" "52 - WELSH" "53 - TELUGU" "54 - PERSIAN" "55 - BENGALI" "56 - AZERBAIJANI" "57 - BRETON" "58 - BASQUE" "59 - NEPALI" "60 - MONGOLIAN" "61 - KAZAKH" "62 - SWAHILI" "63 - GALICIAN" "64 - MARATHI" "65 - PUNJABI" "66 - SINHALA" "67 - KHMER" "68 - SHONA" "69 - YORUBA" "70 - SOMALI" "71 - AFRIKAANS" "72 - OCCITAN" "73 - GEORGIAN" "74 - TAJIK" "75 - SINDHI" "76 - GUJARATI" "77 - AMHARIC" "78 - YIDDISH" "79 - LAO" "80 - UZBEK" "81 - FAROESE" "82 - HAITIANCREOLE" "83 - PASHTO" "84 - TURKMEN" "85 - NYNORSK" "86 - MALTESE" "87 - SANSKRIT" "88 - MYANMAR" "89 - TIBETAN" "90 - TAGALOG" "91 - MALAGASY" "92 - ASSAMESE" "93 - TATAR" "94 - HAWAIIAN" "95 - LINGALA" "96 - HAUSA" "97 - BASHKIR" "98 - JAVANESE" "99 - SUNDANESE" "100 - CANTONESE"
metadata
string or null
hasPriority
boolean
checkFilenameExistence
boolean

Responses

Request samples

Content type
{
  • "dataBase64": "string",
  • "filename": "string",
  • "language": "0 - Auto",
  • "metadata": "string",
  • "hasPriority": true,
  • "checkFilenameExistence": true
}

Response samples

Content type
No sample

Transcripts

Get the status of a specific transcript

This endpoint retrieves the status of a specific transcript by its ID. It returns details such as the call's status, score, audio type, and other related information.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/transcripts/123/status"

Response samples

Content type
No sample

Get a list of transcripts

This endpoint retrieves a list of transcripts based on the provided parameters such as page, rows, date range, file name, topic, sentiment, tag, and content. It returns a paginated list of call records.

Authorizations:
Bearer
query Parameters
Page
integer <int32>
Rows
integer <int32> [ 0 .. 100 ]
DateFrom
string
DateTo
string
FileName
string
Topic
string
Sentiment
string
Tag
string
Content
string
Cluster
string

Responses

Request samples 

curl -X GET "https://api.example.com/api/v1/transcripts?Page=123&Rows=123&DateFrom=sample&DateTo=sample&FileName=sample&Topic=sample&Sentiment=sample&Tag=sample&Content=sample&Cluster=sample"