BRbraiv
Jobs

Get a job

Resolves a deterministic job ID into the common queued, processing, ready, or failed projection. Required scope: jobs:read.

get/jobs/{jobId}

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

jobIdstring required

Deterministic job ID returned by a create operation or job listing.

Response

Current job projection.

idstring required

Deterministic, pollable job ID.

type'import' | 'transcript' | 'dub' | 'captions' | 'shorts' | 'thumbnail' | 'packaging' | 'download' | 'music' required

Product workflow represented by the job.

status'queued' | 'processing' | 'ready' | 'failed' required

Normalized lifecycle shared by jobs and video projections: queued is waiting to start, processing is running, ready completed successfully, and failed reached a terminal error.

videoIdstring

Parent video when applicable.

languagestring

ISO-style language or locale code accepted by the underlying product.

product'plus' | 'premium'

Dubbing voice product:

  • plus — expressive multilingual dubbing using a Braiv voice.
  • premium — dubbing with a cloned voice created from each speaker's source samples.
automationType'generateTitle' | 'generateDescription' | 'zeroPromptThumbnail'

Packaging automation when type is packaging.

resultobject

Type-specific ready-state artifacts.

detailsobject

Type-specific identifiers and context.

Example response

{
  "language": "en"
}

Changes

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