Skip to content
Braiv Docs

Overview

Automate Braiv video workflows

Braiv Public API 1.0.0

Section titled “Braiv Public API 1.0.0”

A job-oriented API for importing media and creating transcripts, translated captions, dubs, shorts, thumbnails, packaging metadata, and downloads.

Authenticate with either Authorization: Bearer <key> or X-Api-Key: <key>. POST requests may include an Idempotency-Key; successful and error responses are replayed for 24 hours when the same key, path, and canonical JSON body are reused.

Informations

Operations

Section titled “ Operations ”
GET
/health
GET
/videos
POST
/videos
GET
/videos/{videoId}
POST
/videos/{videoId}/uploads
GET
/jobs/{jobId}
GET
/videos/{videoId}/jobs
GET
/videos/{videoId}/transcript
GET
/videos/{videoId}/subtitles/{lang}
POST
/videos/{videoId}/captions
GET
/videos/{videoId}/dubs
POST
/videos/{videoId}/dubs
GET
/videos/{videoId}/dubs/{lang}
GET
/videos/{videoId}/shorts
POST
/videos/{videoId}/shorts
GET
/shorts/{shortsRequestId}
GET
/videos/{videoId}/thumbnails
POST
/videos/{videoId}/thumbnails
GET
/thumbnails/{thumbnailRequestId}
GET
/characters
GET
/brand-voices
GET
/folders
POST
/folders
GET
/folders/{folderId}
GET
/videos/{videoId}/professional-hosting
POST
/videos/{videoId}/professional-hosting
GET
/videos/{videoId}/packaging
POST
/videos/{videoId}/packaging
POST
/videos/{videoId}/downloads
GET
/downloads/{downloadRequestId}
POST
/videos/{videoId}/quote
POST
/videos/{videoId}/reservations
GET
/webhook-endpoints
POST
/webhook-endpoints
DELETE
/webhook-endpoints/{endpointId}

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Scoped Braiv Public API key supplied as Authorization: Bearer <key>.

Security scheme type: http

Bearer format: API key

apiKeyHeader

Section titled “apiKeyHeader ”

Scoped Braiv Public API key supplied directly in the X-Api-Key header.

Security scheme type: apiKey

Header parameter name: X-Api-Key