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
  • Targets a workspace where Voice File Jobs are enabled
  • Workspace-unbound user and organization keys must provide workspaceGuid
  • Uses word memories from the key's user, workspace, and organization scopes

Documentation: Complete workflow guide with code examples

post/v1/external/voice-file/jobs

Request

  • Base URL: https://api.tiro.ooo
  • URL: https://api.tiro.ooo/v1/external/voice-file/jobs
  • Auth: HTTP bearer

Request body

workspaceGuidstring

Workspace to use for this job and its workspace word memory. Required for workspace-unbound user and organization keys. A user key must belong to the workspace, and an organization key can only select a workspace in its organization. A workspace-bound key sends its own workspace GUID; any other workspace returns 403000.

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

{
  "workspaceGuid": "ws_a1b2c3d4",
  "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=..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.