v3

OpenAPI 3.1.02026-08-0321138121.5 KB

Live V2

Get the live job's metadata

get/v2/live/{id}

Path parameters

idstring required

Example:45463597-20b7-4af7-b3b3-f5fb778203ab

Id of the live job

Response

The live job's metadata

idstring uuid required

Id of the job

request_idstring required

Debug id

versioninteger required

API version

status'queued' | 'processing' | 'done' | 'error' 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.

created_atstring date-time required

Creation date

completed_atstring date-time nullable

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

custom_metadataobject

Custom metadata given in the initial request

error_codeinteger nullable

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

post_session_metadataobject required

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

kind'live' required

Example response

{
  "id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-45463597",
  "version": 2,
  "created_at": "2023-12-28T09:04:17.210Z",
  "completed_at": "2023-12-28T09:04:37.210Z",
  "custom_metadata": {
    "user": "John Doe"
  },
  "error_code": 500,
  "kind": "live",
  "file": {
    "audio_duration": 3600,
    "number_of_channels": 1
  },
  "request_params": {
    "realtime_processing": {
      "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_config": {
        "spelling_dictionary": {
          "Gettleman": [
            "gettleman"
          ],
          "SQL": [
            "Sequel"
          ]
        }
      },
      "translation_config": {
        "target_languages": [
          "en"
        ]
      }
    },
    "callback_config": {
      "url": "https://callback.example"
    }
  },
  "result": {
    "metadata": {
      "audio_duration": 3600,
      "number_of_distinct_channels": 1,
      "billing_time": 3600,
      "transcription_time": 20
    },
    "transcription": {
      "languages": [
        "en"
      ],
      "sentences": [
        {
          "error": {
            "status_code": 500
          }
        }
      ]
    },
    "translation": {
      "error": {
        "status_code": 500
      },
      "results": [
        {
          "error": {
            "status_code": 500
          },
          "languages": [
            "en"
          ],
          "sentences": [
            {
              "error": {
                "status_code": 500
              }
            }
          ]
        }
      ]
    },
    "summarization": {
      "error": {
        "status_code": 500
      }
    },
    "named_entity_recognition": {
      "error": {
        "status_code": 500
      }
    },
    "sentiment_analysis": {
      "error": {
        "status_code": 500
      }
    },
    "chapterization": {
      "error": {
        "status_code": 500
      }
    }
  }
}