BRbraiv
Hosting

Activate professional hosting

Activates Pro Hosting on the current source, the same as Studio Activate Pro Hosting. Idempotent when Pro Hosting is already live or processing. Required scope: videos:write. Requires a Pro or Business plan. Empty JSON body is valid.

post/videos/{videoId}/professional-hosting

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.

Headers

Idempotency-Keystring

Caller-generated key for safe POST retries. The API retains the first JSON response for 24 hours. Reusing a key with another path or body returns 409 IDEMPOTENCY_REPLAY.

Request body

ActivateProfessionalHostingRequest required

Empty object. Idempotency-Key is optional.

Response

Already on Pro Hosting or Pro ingest is in progress.

videoIdstring required

Library video id.

status'inactive' | 'queued' | 'processing' | 'ready' required

inactive is Standard hosting. queued and processing are Pro Hosting ingest. ready is live Pro playback.

canActivateboolean required

True when the plan allows Pro Hosting and a source file is ready.

hosting'standard' | 'pro' required

Current playback hosting. standard is default ingest. pro is Pro Hosting.

reason'plan_required' | 'missing_input'

Why canActivate is false when status is inactive.

Changes

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