v3

OpenAPI 3.1.02026-08-0321138121.5 KB

Pre-recorded V2

Get the pre recorded job's metadata

get/v2/pre-recorded/{id}

Path parameters

idstring required

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

Id of the pre recorded job

Response

The pre recorded 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'pre-recorded' 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": "pre-recorded",
  "file": {
    "audio_duration": 3600,
    "number_of_channels": 1
  },
  "request_params": {
    "custom_vocabulary_config": {
      "vocabulary": [
        "Westeros",
        {
          "value": "Stark"
        },
        {
          "value": "Night's Watch",
          "pronunciations": [
            "Nightz Watch"
          ],
          "intensity": 0.4,
          "language": "en"
        }
      ],
      "default_intensity": 0.5
    },
    "callback_url": "https://callback.example",
    "callback_config": {
      "url": "https://callback.example"
    },
    "subtitles_config": {
      "formats": [
        "srt"
      ]
    },
    "diarization_config": {
      "number_of_speakers": 3,
      "min_speakers": 1,
      "max_speakers": 2
    },
    "translation_config": {
      "target_languages": [
        "en"
      ]
    },
    "custom_spelling_config": {
      "spelling_dictionary": {
        "Gettleman": [
          "gettleman"
        ],
        "SQL": [
          "Sequel"
        ]
      }
    },
    "audio_to_llm_config": {
      "prompts": [
        "Extract the key points from the transcription"
      ]
    },
    "pii_redaction_config": {
      "processed_text_type": "MARKER"
    }
  },
  "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
      }
    },
    "moderation": {
      "error": {
        "status_code": 500
      }
    },
    "named_entity_recognition": {
      "error": {
        "status_code": 500
      }
    },
    "name_consistency": {
      "error": {
        "status_code": 500
      }
    },
    "structured_data_extraction": {
      "error": {
        "status_code": 500
      }
    },
    "sentiment_analysis": {
      "error": {
        "status_code": 500
      }
    },
    "audio_to_llm": {
      "error": {
        "status_code": 500
      },
      "results": [
        {
          "error": {
            "status_code": 500
          }
        }
      ]
    },
    "sentences": {
      "error": {
        "status_code": 500
      }
    },
    "display_mode": {
      "error": {
        "status_code": 500
      }
    },
    "chapterization": {
      "error": {
        "status_code": 500
      }
    },
    "diarization": {
      "error": {
        "status_code": 500
      }
    }
  }
}