Get result

Get live transcription’s status, parameters and result.

GET /v2/live/{id}

Get the live job's metadata

cURL

curl --request GET \
  --url https://api.gladia.io/v2/live/{id} \
  --header 'x-gladia-key: <api-key>'

import requests

url = "https://api.gladia.io/v2/live/{id}"

headers = {"x-gladia-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-gladia-key': '<api-key>'}};

fetch('https://api.gladia.io/v2/live/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gladia.io/v2/live/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-gladia-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gladia.io/v2/live/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-gladia-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gladia.io/v2/live/{id}")
  .header("x-gladia-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gladia.io/v2/live/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-gladia-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-45463597",
  "version": 2,
  "created_at": "2023-12-28T09:04:17.210Z",
  "post_session_metadata": {},
  "kind": "live",
  "completed_at": "2023-12-28T09:04:37.210Z",
  "custom_metadata": {
    "user": "John Doe"
  },
  "error_code": 500,
  "file": {
    "id": "<string>",
    "filename": "<string>",
    "source": "<string>",
    "audio_duration": 3600,
    "number_of_channels": 1
  },
  "request_params": {
    "encoding": "wav/pcm",
    "bit_depth": 16,
    "sample_rate": 16000,
    "channels": 1,
    "model": "solaria-1",
    "endpointing": 0.05,
    "maximum_duration_without_endpointing": 5,
    "language_config": {
      "languages": [],
      "code_switching": false
    },
    "pre_processing": {
      "audio_enhancer": false,
      "speech_threshold": 0.6
    },
    "realtime_processing": {
      "custom_vocabulary": false,
      "custom_vocabulary_config": {
        "vocabulary": [
          "Westeros",
          {
            "value": "Stark"
          },
          {
            "value": "Night's Watch",
            "pronunciations": [
              "Nightz Watch"
            ],
            "intensity": 0.4,
            "language": "en"
          }
        ],
        "default_intensity": 0.5
      },
      "custom_spelling": false,
      "custom_spelling_config": {
        "spelling_dictionary": {
          "Gettleman": [
            "gettleman"
          ],
          "SQL": [
            "Sequel"
          ]
        }
      },
      "translation": false,
      "translation_config": {
        "target_languages": [
          "en"
        ],
        "model": "base",
        "match_original_utterances": true,
        "lipsync": true,
        "context_adaptation": true,
        "context": "<string>",
        "informal": false
      },
      "named_entity_recognition": false,
      "sentiment_analysis": false
    },
    "post_processing": {
      "summarization": false,
      "summarization_config": {
        "type": "general"
      },
      "chapterization": false
    },
    "messages_config": {
      "receive_partial_transcripts": false,
      "receive_final_transcripts": true,
      "receive_speech_events": true,
      "receive_pre_processing_events": true,
      "receive_realtime_processing_events": true,
      "receive_post_processing_events": true,
      "receive_acknowledgments": true,
      "receive_errors": true,
      "receive_lifecycle_events": false
    },
    "callback": false,
    "callback_config": {
      "url": "https://callback.example",
      "receive_partial_transcripts": false,
      "receive_final_transcripts": true,
      "receive_speech_events": false,
      "receive_pre_processing_events": true,
      "receive_realtime_processing_events": true,
      "receive_post_processing_events": true,
      "receive_acknowledgments": false,
      "receive_errors": false,
      "receive_lifecycle_events": true
    }
  },
  "result": {
    "metadata": {
      "audio_duration": 3600,
      "number_of_distinct_channels": 1,
      "billing_time": 3600,
      "transcription_time": 20
    },
    "transcription": {
      "full_transcript": "<string>",
      "languages": [
        "en"
      ],
      "utterances": [
        {
          "start": 123,
          "end": 123,
          "confidence": 123,
          "channel": 1,
          "words": [
            {
              "word": "<string>",
              "start": 123,
              "end": 123,
              "confidence": 123
            }
          ],
          "text": "<string>",
          "language": "en",
          "speaker": 1
        }
      ],
      "sentences": [
        {
          "success": true,
          "is_empty": true,
          "exec_time": 123,
          "error": {
            "status_code": 500,
            "exception": "<string>",
            "message": "<string>"
          },
          "results": [
            "<string>"
          ]
        }
      ],
      "subtitles": [
        {
          "format": "srt",
          "subtitles": "<string>"
        }
      ]
    },
    "translation": {
      "success": true,
      "is_empty": true,
      "exec_time": 123,
      "error": {
        "status_code": 500,
        "exception": "<string>",
        "message": "<string>"
      },
      "results": [
        {
          "error": {
            "status_code": 500,
            "exception": "<string>",
            "message": "<string>"
          },
          "full_transcript": "<string>",
          "languages": [
            "en"
          ],
          "utterances": [
            {
              "start": 123,
              "end": 123,
              "confidence": 123,
              "channel": 1,
              "words": [
                {
                  "word": "<string>",
                  "start": 123,
                  "end": 123,
                  "confidence": 123
                }
              ],
              "text": "<string>",
              "language": "en",
              "speaker": 1
            }
          ],
          "sentences": [
            {
              "success": true,
              "is_empty": true,
              "exec_time": 123,
              "error": {
                "status_code": 500,
                "exception": "<string>",
                "message": "<string>"
              },
              "results": [
                "<string>"
              ]
            }
          ],
          "subtitles": [
            {
              "format": "srt",
              "subtitles": "<string>"
            }
          ]
        }
      ]
    },
    "summarization": {
      "success": true,
      "is_empty": true,
      "exec_time": 123,
      "error": {
        "status_code": 500,
        "exception": "<string>",
        "message": "<string>"
      },
      "results": "<string>"
    },
    "named_entity_recognition": {
      "success": true,
      "is_empty": true,
      "exec_time": 123,
      "error": {
        "status_code": 500,
        "exception": "<string>",
        "message": "<string>"
      },
      "results": [
        {
          "entity_type": "<string>",
          "text": "<string>",
          "start": 123,
          "end": 123
        }
      ]
    },
    "sentiment_analysis": {
      "success": true,
      "is_empty": true,
      "exec_time": 123,
      "error": {
        "status_code": 500,
        "exception": "<string>",
        "message": "<string>"
      },
      "results": "<string>"
    },
    "chapterization": {
      "success": true,
      "is_empty": true,
      "exec_time": 123,
      "error": {
        "status_code": 500,
        "exception": "<string>",
        "message": "<string>"
      },
      "results": {}
    },
    "messages": [
      "<string>"
    ]
  }
}

{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 401,
  "message": "gladia key not found"
}

{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 404,
  "message": "Not found"
}

Authorizations

x-gladia-key · string · header · required

Your personal Gladia API key

Path Parameters

id · string · required

Id of the live job

Example:

"45463597-20b7-4af7-b3b3-f5fb778203ab"

Response

200

application/json

The live job's metadata

id · string<uuid> · required

Id of the job

Example:

"45463597-20b7-4af7-b3b3-f5fb778203ab"

request_id · string · required

Debug id

Example:

"G-45463597"

version · integer · required

API version

Example:

2

status · enum<string> · required

"queued": the job has been queued. "processing": the job is being processed. "done": the job has been processed and the result is available. "error": an error occurred during the job's processing.

Available options: queued, processing, done, error

created_at · string<date-time> · required

Creation date

Example:

"2023-12-28T09:04:17.210Z"

post_session_metadata · object · required

For debugging purposes, send data that could help to identify issues

kind · enum<string> · default: live · required

Available options: live

Example:

"live"

completed_at · string<date-time> | null

Completion date when status is "done" or "error"

Example:

"2023-12-28T09:04:37.210Z"

custom_metadata · object

Custom metadata given in the initial request

Example:

{ "user": "John Doe" }

error_code · integer | null

HTTP status code of the error if status is "error"

Required range: 400 <= x <= 599

Example:

500

file · object | null

The file data you uploaded. Can be null if status is "error"

Show child attributes

request_params · object | null

Parameters used for this live transcription. Can be null if status is "error"

Show child attributes

result · object | null

Live transcription's result when status is "done"

Show child attributes