Skip to main content
GET
Get a job

Authorizations

Authorization
string
header
required

An API key from the dashboard, sk_live_…, sent as Authorization: Bearer sk_live_….

Path Parameters

id
string
required

The job id returned when the recording was submitted.

Pattern: ^job_[0-9a-f-]{36}$

Response

Job state, with the transcript once completed or the error once failed

id
string
required
Pattern: ^job_[0-9a-f-]{36}$
tool
enum<string>
required
Available options:
transcription
status
enum<string>
required

queued and running are in progress; completed carries result; failed carries error.

Available options:
queued,
running,
completed,
failed
provider
enum<string>
required
Available options:
assemblyai,
deepgram,
elevenlabs
model
string | null
required
attempt_status
enum<string>
required

Where the current provider attempt is: waiting means the provider accepted the audio and Helve is polling or awaiting its callback; unknown means Helve is reconciling an uncertain submission rather than re-sending it.

Available options:
queued,
submitting,
waiting,
unknown,
completed,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
finished_at
string<date-time> | null
required

Set once the job is completed or failed.

result
object | null
required

The transcript, present only when status is completed.

error
object | null
required

Why the job failed, present only when status is failed.