api.video Python client

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

• Table of contents
• Project description
• Getting started
  • Requirements
  • Installation
  • Code samples
    • Automatic authentication
    • Manual authentication
• Documentation
  • API Endpoints
    • AnalyticsApi
    • CaptionsApi
    • ChaptersApi
    • LiveStreamsApi
    • PlayerThemesApi
    • SummariesApi
    • TagsApi
    • UploadTokensApi
    • VideosApi
    • WatermarksApi
    • WebhooksApi
  • Models
• Have you gotten use from this API client?
• Contribution

Project description

api.video's Python API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started

Requirements

Python >= 3.6

Installation

pip install api.video

Code samples

Automatic authentication

list all videos:

import apivideo
from apivideo.apis import VideosApi

api_key = "__API_KEY__"

with apivideo.AuthenticatedApiClient(api_key) as client:
    # if you rather like to use the sandbox environment:
    # with apivideo.AuthenticatedApiClient(api_key, production=False) as client:

    videos_api = VideosApi(client)
    videos = videos_api.list()

In this context the client will keep its authentication updated.

Manual authentication

If there is an issue, like you think a refresh token may have been exposed, you can manually retrieve a new one. Otherwise, authentication is handled for you. When you retrieve a new refresh token, the old one becomes invalid. Here is the code, where you retrieve a list of videos and then refresh your token:

import apivideo
from apivideo.apis import VideosApi
from apivideo.exceptions import ApiAuthException

api_key = "__API_KEY__"

client = apivideo.AuthenticatedApiClient(api_key)
# if you rather like to use the sandbox environment:
# client = apivideo.AuthenticatedApiClient(api_key, production=False)
client.connect()
videos_api = VideosApi(client)
videos = videos_api.list()

try:
    client.refresh_token()
except ApiAuthException:
    print("cannot refresh token !")

...

Documentation

API Endpoints

All URIs are relative to https://ws.api.video

AnalyticsApi

Method	HTTP request	Description
get_aggregated_metrics	GET /data/metrics/{metric}/{aggregation}	Retrieve aggregated metrics
get_metrics_breakdown	GET /data/buckets/{metric}/{breakdown}	Retrieve metrics in a breakdown of dimensions
get_metrics_over_time	GET /data/timeseries/{metric}	Retrieve metrics over time

CaptionsApi

Method	HTTP request	Description
upload	POST /videos/{videoId}/captions/{language}	Upload a caption
get	GET /videos/{videoId}/captions/{language}	Retrieve a caption
update	PATCH /videos/{videoId}/captions/{language}	Update a caption
delete	DELETE /videos/{videoId}/captions/{language}	Delete a caption
list	GET /videos/{videoId}/captions	List video captions

ChaptersApi

Method	HTTP request	Description
upload	POST /videos/{videoId}/chapters/{language}	Upload a chapter
get	GET /videos/{videoId}/chapters/{language}	Retrieve a chapter
delete	DELETE /videos/{videoId}/chapters/{language}	Delete a chapter
list	GET /videos/{videoId}/chapters	List video chapters

LiveStreamsApi

Method	HTTP request	Description
create	POST /live-streams	Create live stream
get	GET /live-streams/{liveStreamId}	Retrieve live stream
update	PATCH /live-streams/{liveStreamId}	Update a live stream
delete	DELETE /live-streams/{liveStreamId}	Delete a live stream
list	GET /live-streams	List all live streams
upload_thumbnail	POST /live-streams/{liveStreamId}/thumbnail	Upload a thumbnail
delete_thumbnail	DELETE /live-streams/{liveStreamId}/thumbnail	Delete a thumbnail
complete	PUT /live-streams/{liveStreamId}/complete	Complete a live stream

PlayerThemesApi

Method	HTTP request	Description
create	POST /players	Create a player
get	GET /players/{playerId}	Retrieve a player
update	PATCH /players/{playerId}	Update a player
delete	DELETE /players/{playerId}	Delete a player
list	GET /players	List all player themes
upload_logo	POST /players/{playerId}/logo	Upload a logo
delete_logo	DELETE /players/{playerId}/logo	Delete logo

SummariesApi

Method	HTTP request	Description
create	POST /summaries	Generate video summary
update	PATCH /summaries/{summaryId}/source	Update summary details
delete	DELETE /summaries/{summaryId}	Delete video summary
list	GET /summaries	List summaries
get_summary_source	GET /summaries/{summaryId}/source	Get summary details

TagsApi

Method	HTTP request	Description
list	GET /tags	List all video tags

UploadTokensApi

Method	HTTP request	Description
create_token	POST /upload-tokens	Generate an upload token
get_token	GET /upload-tokens/{uploadToken}	Retrieve upload token
delete_token	DELETE /upload-tokens/{uploadToken}	Delete an upload token
list	GET /upload-tokens	List all active upload tokens

VideosApi

Method	HTTP request	Description
create	POST /videos	Create a video object
upload	POST /videos/{videoId}/source	Upload a video
upload_with_upload_token	POST /upload	Upload with an delegated upload token
get	GET /videos/{videoId}	Retrieve a video object
update	PATCH /videos/{videoId}	Update a video object
delete	DELETE /videos/{videoId}	Delete a video object
list	GET /videos	List all video objects
upload_thumbnail	POST /videos/{videoId}/thumbnail	Upload a thumbnail
pick_thumbnail	PATCH /videos/{videoId}/thumbnail	Set a thumbnail
get_discarded	GET /discarded/videos/{videoId}	Retrieve a discarded video object
get_status	GET /videos/{videoId}/status	Retrieve video status and details
list_discarded	GET /discarded/videos	List all discarded video objects
update_discarded	PATCH /discarded/videos/{videoId}	Update a discarded video object

WatermarksApi

Method	HTTP request	Description
upload	POST /watermarks	Upload a watermark
delete	DELETE /watermarks/{watermarkId}	Delete a watermark
list	GET /watermarks	List all watermarks

WebhooksApi

Method	HTTP request	Description
create	POST /webhooks	Create Webhook
get	GET /webhooks/{webhookId}	Retrieve Webhook details
delete	DELETE /webhooks/{webhookId}	Delete a Webhook
list	GET /webhooks	List all webhooks

Models

• AccessToken
• AdditionalBadRequestErrors
• AnalyticsAggregatedMetricsResponse
• AnalyticsAggregatedMetricsResponseContext
• AnalyticsAggregatedMetricsResponseContextTimeframe
• AnalyticsData
• AnalyticsMetricsBreakdownResponse
• AnalyticsMetricsBreakdownResponseContext
• AnalyticsMetricsBreakdownResponseData
• AnalyticsMetricsOverTimeResponse
• AnalyticsMetricsOverTimeResponseContext
• AnalyticsMetricsOverTimeResponseData
• AnalyticsPlays400Error
• AnalyticsPlaysResponse
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• ConflictError
• DiscardedVideoUpdatePayload
• FilterBy
• FilterBy1
• FilterBy2
• Link
• ListTagsResponse
• ListTagsResponseData
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamUpdatePayload
• Metadata
• Model403ErrorSchema
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RefreshTokenPayload
• RestreamsRequestObject
• RestreamsResponseObject
• SummariesListResponse
• Summary
• SummaryCreationPayload
• SummarySource
• SummaryUpdatePayload
• TokenCreationPayload
• TokenListResponse
• TooManyRequests
• UnrecognizedRequestUrl
• UploadToken
• Video
• VideoAssets
• VideoClip
• VideoCreationPayload
• VideoSource
• VideoSourceLiveStream
• VideoSourceLiveStreamLink
• VideoStatus
• VideoStatusEncoding
• VideoStatusEncodingMetadata
• VideoStatusIngest
• VideoStatusIngestReceivedParts
• VideoThumbnailPickPayload
• VideoUpdatePayload
• VideoWatermark
• VideosListResponse
• Watermark
• WatermarksListResponse
• Webhook
• WebhooksCreationPayload
• WebhooksListResponse

Have you gotten use from this API client?

Please take a moment to leave a star on the client

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.