v1

latestOpenAPI 3.0.42026-07-26263457588.1 KB
Stream Video Library

Get Video Library

get/videolibrary/{id}

Path parameters

idinteger required

The ID of the Video Library that will be returned

Response

The requested video library

Idinteger
Namestring nullable

The name of the Video Library.

VideoCountinteger

The number of videos in the video library

TrafficUsageinteger

The amount of traffic usage this month

StorageUsageinteger

The total amount of storage used by the library

DateCreatedstring date-time

The date when the video library was created

DateModifiedstring date-time

The date when the video library was last modified

ReplicationRegionsstring[] nullable

The geo-replication regions of the underlying storage zone

ApiKeystring nullable

The API key used for authenticating with the video library

ReadOnlyApiKeystring nullable

The read-only API key used for authenticating with the video library

HasWatermarkboolean

Determines if the video library has a watermark configured

WatermarkPositionLeftinteger

The left offset of the watermark position (in %)

WatermarkPositionTopinteger

The top offset of the watermark position (in %)

WatermarkWidthinteger

The width of the watermark (in %)

PullZoneIdinteger

The ID of the connected underlying pull zone

StorageZoneIdinteger

The ID of the connected underlying storage zone

WatermarkHeightinteger

The height of the watermark (in %)

EnabledResolutionsstring nullable

The comma separated list of enabled resolutions

ViAiPublisherIdstring nullable

The vi.ai publisher id for advertising configuration

VastTagUrlstring nullable

The URL of the VAST tag endpoint for advertising configuration

WebhookUrlstring nullable

The webhook URL of the video library

CaptionsFontSizeinteger

The captions display font size

CaptionsFontColorstring nullable

The captions display font color

CaptionsBackgroundstring nullable

The captions display background color

UILanguagestring nullable

The UI language of the player

AllowEarlyPlayboolean nullable

Determines if the Early-Play feature is enabled

PlayerTokenAuthenticationEnabledboolean

Determines if the player token authentication is enabled

AllowedReferrersstring[] nullable

The list of allowed referrer domains allowed to access the library

BlockedReferrersstring[] nullable

The list of blocked referrer domains blocked from accessing the library

BlockNoneReferrerboolean

Determines if the requests without a referrer are blocked

EnableMP4Fallbackboolean

Determines if the MP4 fallback feature is enabled

KeepOriginalFilesboolean

Determines if the original video files should be stored after encoding

AllowDirectPlayboolean

Determines direct play URLs are enabled for the library

EnableDRMboolean

Determines if the DRM is enabled

DrmVersion0 | 1 | 2

0 = Basic 1 = Enterprise 2 = BasicV2

Bitrate240pinteger

The bitrate used for encoding 240p videos

Bitrate360pinteger

The bitrate used for encoding 360p videos

Bitrate480pinteger

The bitrate used for encoding 480p videos

Bitrate720pinteger

The bitrate used for encoding 720p videos

Bitrate1080pinteger

The bitrate used for encoding 1080p videos

Bitrate1440pinteger

The bitrate used for encoding 1440p videos

Bitrate2160pinteger

The bitrate used for encoding 2160p videos

ApiAccessKeystring nullable
ShowHeatmapboolean

Determines if the video watch heatmap should be displayed in the player.

EnableContentTaggingboolean

Determines if content tagging should be enabled for this library.

PullZoneType0 | 1

0 = Premium 1 = Volume

CustomHTMLstring nullable

The custom HTMl that is added into the head of the HTML player.

Controlsstring nullable

The list of controls on the video player.

PlaybackSpeedsstring nullable

The list of playback speeds available in the video player.

PlayerKeyColorstring nullable

The key color of the player.

FontFamilystring nullable

The captions font family.

WatermarkVersioninteger
EnableTranscribingboolean

Determines if the automatic audio transcribing is currently enabled for this zone.

EnableTranscribingTitleGenerationboolean

Determines if automatic transcribing title generation is currently enabled.

EnableTranscribingDescriptionGenerationboolean

Determines if automatic transcribing description generation is currently enabled.

EnableTranscribingChaptersGenerationboolean

Determines if automatic transcribing chapters generation is currently enabled.

EnableTranscribingMomentsGenerationboolean

Determines if automatic transcribing moments generation is currently enabled.

TranscribingCaptionLanguagesstring[] nullable

The list of languages that the captions will be automatically transcribed to.

EnableCaptionsInPlaylistboolean nullable

Determines if any associated captions will be automatically signaled in the HLS master playlist via EXT-X-MEDIA tags, allowing client players to show captions.

RememberPlayerPositionboolean

Determines if the player will automatically remember the playback position.

EnableMultiAudioTrackSupportboolean

Determines if multiple output audio track support is enabled on video library.

UseSeparateAudioStreamboolean

Determines whether output audio stream should be split from video stream segments.

JitEncodingEnabledboolean

Determines whether JIT encoding should be used for the library. Supported in premium encoding only.

EncodingTier0 | 1

0 = Free 1 = Premium

OutputCodecsstring nullable

Specifies which video codecs are used for encoding, provided as a comma-separated (CSV) string. Free encoding tier supports only x264. A premium encoding tier adds support for vp9, hevc, and av1.

DrmBasePriceOverridenumber nullable

DRM (enterprise) monthly base price for this video library if it differs from list price.

DrmCostPerLicenseOverridenumber nullable

DRM (enterprise) cost per license for this video library if it differs from list price.

TranscribingPriceOverridenumber nullable
PremiumEncodingPriceOverridenumber nullable
MonthlyChargesTranscribingnumber
MonthlyChargesPremiumEncodingnumber
MonthlyChargesEnterpriseDrmnumber
FeatureFlagsstring nullable
PlayerVersioninteger
RemoveMetadataFromFallbackVideosboolean

Marks whether all potential video metadata should be removed from the fallback files. Default false.

ScaleVideoUsingBothDimensionsboolean

Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes. Default true.

ExposeOriginalsboolean

Marks whether original video files should be exposed via CDN.

ExposeVideoMetadataboolean

Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed.

EnableCompactControlsboolean

Marks whether compact controls should be enabled for the player.