BRbraiv
Hosting

Get professional hosting status

Returns whether the video is on Standard or Pro hosting, and whether the caller can activate Pro Hosting. Required scope: videos:read. Pro and Business plans can activate. Poll this after activateProfessionalHosting until status is ready.

get/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.

Response

Current hosting state.

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.