BRbraiv
Videos

Get a video

Returns the normalized library record and current import/transcript projections. Required scope: videos:read.

get/videos/{videoId}

Request

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

Path parameters

videoIdstring required

Braiv library video document ID.

Response

The accessible video resource.

idstring required

Library video ID.

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.

titlestring

Current video title.

descriptionstring

Current video description.

durationnumber

Media duration in seconds.

posterUrlstring uri

Current poster image URL.

providerstring

Internal source provider label.

mediaType'video' | 'audio'

Ingested media kind.

defaultLanguageCodestring

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

urlstring uri

Primary playback URL when available.

urlMultiobject

Playback URLs keyed by language code.

workspaceIdstring

Owning workspace, if any.

folderIdsstring[]

Studio folder ids this video belongs to (UserVideos.tags).

createdAtstring date-time

ISO creation timestamp.

Example response

{
  "defaultLanguageCode": "en",
  "import": {
    "language": "en"
  },
  "transcript": {
    "language": "en"
  }
}

Changes

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