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
CREATEDstatus — 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
인증
API key in format {id}.{secret}.
The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.
List and search endpoints drop out-of-scope notes from the response without an
error. Single-note reads and their sub-resources return 404, the same response
as a deleted note. See What notes a system key reads.
본문
Optional parameters for workspace selection, transcription, and translation.
workspaceGuidis required for workspace-unbound user and organization keys- Workspace-bound keys use their bound workspace and cannot select another workspace
- If
transcriptLocaleHintsis omitted, language is auto-detected from audio - If
translationLocalesis omitted, no translations are generated
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. Omit for a workspace-bound key.
"ws_a1b2c3d4"
Locale hints for transcription.
- Maximum 1 locale
- If omitted, language is auto-detected from audio content
1Optional locales for translation (max 5)
5응답
Job created successfully
Response returned when a new Voice File Job is created. Contains the job ID and a presigned URL for uploading the audio file.
Next Steps:
- Upload your audio file to
uploadUriusing HTTP PUT - Call
PUT /v1/external/voice-file/jobs/{id}/upload-completeto start processing
Unique job identifier (UUID format). Use this ID in subsequent API calls.
"b2d1ab32-3fe2-4201-b0b4-391abdbaa023"
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)
"https://tiro-uploads.s3.amazonaws.com/voice-files/job-abc123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."