Skip to main content
GET
/
v2
/
live
/
{id}
Get the live job's metadata
curl --request GET \
  --url https://api.gladia.io/v2/live/{id} \
  --header 'x-gladia-key: <api-key>'
{
  "id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-45463597",
  "version": 2,
  "status": "queued",
  "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,
  "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_spelling": false,
      "translation": 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
    }
  }
}

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

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

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

​
request_params
object

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

​
result
object

Live transcription's result when status is "done"