Speech Analytics

Retrieve a transcription

Changed on

Returns the transcription for the request identified by request_id, including transcript, speaker turns, and insights when available.

get/v1/speech-analytics/{request_id}

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/speech-analytics/{request_id}
  • Auth
    HTTP bearer

Path parameters

request_idstring required
Example:e865ea07-25af-4fdd-876e-04b0d41d5ebd

The request_id of the transcription, returned when the file was uploaded.

Response

Returns the completed transcription.

request_idstring required

Transcription request ID.

language'en' | 'de' | 'es' | 'fr' | 'it' | 'null' nullable required

Language of the transcription, as a two-letter ISO 639-1 code. One of en (English), de (German), es (Spanish), fr (French), or it (Italian). null lets the platform auto-detect the language.

durationinteger nullable required

File duration in seconds.

chargestring required

Total transcription charge in USD.

status'completed' | 'failed' required

Outcome of the transcription. One of completed (the transcript was produced) or failed (the transcription could not be produced).

transcription_datestring date-time required

Date and time of the transcription in ISO 8601 format.

transcription_scorestring nullable required

Conversation sentiment score. Scores from 1.0 to 3.0 are negative; scores from 4.0 to 5.0 are positive.

transcription_summarystring nullable required

Transcription summary.

original_filestring required

Uploaded file URL.

Example response

{
  "transcript": {
    "channel_1": "Hi there",
    "channel_2": "Hello"
  },
  "turns": [
    {
      "speaker": "channel_1",
      "s": 600,
      "e": 700,
      "text": "Hi",
      "sentiment": "positive"
    }
  ],
  "request_id": "e84f350f-6da7-4b56-80eb-41dec572626b",
  "duration": 102,
  "charge": "0.01",
  "transcription_date": "2023-01-09T10:04:39.734Z",
  "transcription_score": "3.8",
  "transcription_summary": "The agent and client discussed call recording and call transcription",
  "original_file": "https://api.wavix.com/v1/files/uuid"
}

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from no type to string null for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new completed enum value to the response property for the response status

    • warning

      added the new de enum value to the response property for the response status

    • warning

      added the new en enum value to the response property for the response status

    • warning

      added the new es enum value to the response property for the response status

    • warning

      added the new failed enum value to the response property for the response status

    • warning

      added the new fr enum value to the response property for the response status

    • warning

      added the new it enum value to the response property for the response status

    • warning

      added the new undefined enum value to the response property for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status