Sign in

v1

latestOpenAPI 3.1.02026-07-226875162.5 KB
Voice File

Create Voice File Job

Create a new Voice File Job for audio transcription and optional translation.

  • Returns a presigned upload URI for your audio file
  • Optionally specify source language hints and target translation locales
  • Job starts in CREATED status — upload your file to begin processing
  • Requires a user or system API key bound to a workspace where Voice File Jobs are enabled

Documentation: Complete workflow guide with code examples

post/v1/external/voice-file/jobs

Request body

transcriptLocaleHintsstring[]

Locale hints for transcription.

  • Maximum 1 locale
  • If omitted, language is auto-detected from audio content
translationLocalesstring[]

Optional locales for translation (max 5)

Example request

{
  "transcriptLocaleHints": [
    "en_US"
  ],
  "translationLocales": [
    "ko_KR",
    "ja_JP"
  ]
}

Response

Job created successfully

idstring required

Unique job identifier (UUID format). Use this ID in subsequent API calls.

uploadUristring uri required

Presigned URL for uploading the audio file.

  • Use HTTP PUT method to upload
  • URL expires in 1 hour
  • Set appropriate Content-Type header (e.g., audio/mpeg, audio/wav)

Example response

{
  "id": "b2d1ab32-3fe2-4201-b0b4-391abdbaa023",
  "uploadUri": "https://tiro-uploads.s3.amazonaws.com/voice-files/job-abc123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
}