Voice File

Get Voice File Job

Retrieve the current status and details of a Voice File Job.

  • Subscribe to the voice_file_job.completed and voice_file_job.failed webhooks to learn when a job finishes (recommended)
  • Poll this endpoint until status reaches COMPLETED or FAILED when you cannot receive webhooks
  • Once completed, use the transcript and translation endpoints to retrieve results

Documentation: Webhooks and polling strategy

get/v1/external/voice-file/jobs/{jobId}

Request

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

Path parameters

jobIdstring required

The job ID returned from Create Voice File Job

Response

Job details

idstring required

Unique job identifier (UUID format)

status'CREATED' | 'UPLOADED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Current job processing status:

  • CREATED: Job created, waiting for file upload
  • UPLOADED: File uploaded, waiting for processing to start
  • PROCESSING: Transcription/translation in progress
  • COMPLETED: All processing finished, results available
  • FAILED: Processing failed (check errorMessage). A job also becomes FAILED when only summary generation fails; check transcriptAvailable
fileUploadedAtstring date-time nullable

Timestamp when file upload was completed. Null if not yet uploaded.

processStartedAtstring date-time nullable

Timestamp when processing started. Null if not yet started.

processCompletedAtstring date-time nullable

Timestamp when processing completed. Null if still processing.

errorMessagestring nullable

Error message if job failed. Null for successful jobs.

transcriptAvailableboolean

Whether the transcript can be fetched. Can be true on a FAILED job when transcription succeeded and a later step failed.

Example response

{
  "id": "b2d1ab32-3fe2-4201-b0b4-391abdbaa023",
  "status": "PROCESSING",
  "fileUploadedAt": "2025-07-20T10:00:20Z",
  "processStartedAt": "2025-07-20T10:01:00Z"
}

Changes

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