Editframe logoEditframe

Create Transcription

POST /api/v1/transcriptions
Request payload data
{
file_id: string
track_id: number
}
Response payload data
{
id: string
status: "complete" | "created" | "failed" | "pending" | "transcribing"
}

Get Transcription Progress

GET /api/v1/transcriptions/:id/progress
Response payload data
Class CompletionIterator
function constructor(
eventSource: StreamEventSource 🔗
)
returns CompletionIterator 🔗
property eventSource: StreamEventSource 🔗
property index: number
property isComplete: boolean
property on:
(
event: "progress"
callback:
(
event: ProgressEvent 🔗
)
returns void
)
returns this
property resolversNext: PromiseWithResolvers<void>
function [asyncIterator](
)
returns AsyncIterator<ProgressEvent 🔗 | CompleteEvent 🔗, any, undefined>
function abort(
)
returns void
function push(
event: ProgressEvent 🔗 | CompleteEvent 🔗
)
returns void
function whenComplete(
)
returns Promise<Array<ProgressEvent 🔗 | CompleteEvent 🔗>>
accessor queueLength: number

Get Transcription Info

GET /api/v1/transcriptions/:id
Response payload data
{
id: string
status: "complete" | "created" | "failed" | "pending" | "transcribing"
}