Skip to content

Latest commit

 

History

History
451 lines (340 loc) · 25.4 KB

README.md

File metadata and controls

451 lines (340 loc) · 25.4 KB
Raw

badge   badge   badge

api.video Go 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

Project description

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

Getting started

Installation

go get github.com/apivideo/api.video-go-client

Code sample

For a more advanced usage you can checkout the rest of the documentation in the docs directory

package main

import (
    "fmt"
    "os"
    apivideosdk "github.com/apivideo/api.video-go-client"
)

func main() {
    //Connect to production environment
    client := apivideosdk.ClientBuilder("YOUR_API_KEY").Build()

    // if you rather like to use the sandbox environment:
    // client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_KEY").Build()


    //List Videos
    //First create the url options for searching
    opts := apivideosdk.VideosApiListRequest{}.
        CurrentPage(1).
        PageSize(25).
        SortBy("publishedAt").
        SortOrder("desc")

    //Then call the List endpoint with the options
    result, err := client.Videos.List(opts)

    if err != nil {
        fmt.Println(err)
    }

    for _, video := range result.Data {
        fmt.Printf("%s\n", video.VideoId)
        fmt.Printf("%s\n", *video.Title)
    }


    //Upload a video
    //First create a container
    create, err := client.Videos.Create(apivideosdk.VideoCreationPayload{Title: "My video title"})

    if err != nil {
        fmt.Println(err)
    }

    //Then open the video file
    videoFile, err := os.Open("path/to/video.mp4")

    if err != nil {
        fmt.Println(err)
    }

    //Finally upload your video to the container with the videoId
    uploadedVideo, err := client.Videos.UploadFile(create.VideoId, videoFile)

    if err != nil {
        fmt.Println(err)
    }


    //And get the assets
    fmt.Printf("%s\n", *uploadedVideo.Assets.Hls)
    fmt.Printf("%s\n", *uploadedVideo.Assets.Iframe)
}

Documentation

API Endpoints

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

Analytics

Retrieve an instance of the Analytics API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
analyticsApi := client.Analytics
Endpoints
Method HTTP request Description
GetAggregatedMetrics Get /data/metrics/{metric}/{aggregation} Retrieve aggregated metrics
GetMetricsBreakdown Get /data/buckets/{metric}/{breakdown} Retrieve metrics in a breakdown of dimensions
GetMetricsOverTime Get /data/timeseries/{metric} Retrieve metrics over time

Captions

Retrieve an instance of the Captions API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
captionsApi := client.Captions
Endpoints
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

Chapters

Retrieve an instance of the Chapters API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
chaptersApi := client.Chapters
Endpoints
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

LiveStreams

Retrieve an instance of the LiveStreams API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
liveStreamsApi := client.LiveStreams
Endpoints
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
UploadThumbnail Post /live-streams/{liveStreamId}/thumbnail Upload a thumbnail
DeleteThumbnail Delete /live-streams/{liveStreamId}/thumbnail Delete a thumbnail
Complete Put /live-streams/{liveStreamId}/complete Complete a live stream

PlayerThemes

Retrieve an instance of the PlayerThemes API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
playerThemesApi := client.PlayerThemes
Endpoints
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
UploadLogo Post /players/{playerId}/logo Upload a logo
DeleteLogo Delete /players/{playerId}/logo Delete logo

Summaries

Retrieve an instance of the Summaries API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
summariesApi := client.Summaries
Endpoints
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
GetSummarySource Get /summaries/{summaryId}/source Get summary details

Tags

Retrieve an instance of the Tags API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
tagsApi := client.Tags
Endpoints
Method HTTP request Description
List Get /tags List all video tags

UploadTokens

Retrieve an instance of the UploadTokens API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
uploadTokensApi := client.UploadTokens
Endpoints
Method HTTP request Description
CreateToken Post /upload-tokens Generate an upload token
GetToken Get /upload-tokens/{uploadToken} Retrieve upload token
DeleteToken Delete /upload-tokens/{uploadToken} Delete an upload token
List Get /upload-tokens List all active upload tokens

Videos

Retrieve an instance of the Videos API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
videosApi := client.Videos
Endpoints
Method HTTP request Description
Create Post /videos Create a video object
Upload Post /videos/{videoId}/source Upload a video
UploadWithUploadToken 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
UploadThumbnail Post /videos/{videoId}/thumbnail Upload a thumbnail
PickThumbnail Patch /videos/{videoId}/thumbnail Set a thumbnail
GetDiscarded Get /discarded/videos/{videoId} Retrieve a discarded video object
GetStatus Get /videos/{videoId}/status Retrieve video status and details
ListDiscarded Get /discarded/videos List all discarded video objects
UpdateDiscarded Patch /discarded/videos/{videoId} Update a discarded video object

Watermarks

Retrieve an instance of the Watermarks API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
watermarksApi := client.Watermarks
Endpoints
Method HTTP request Description
Upload Post /watermarks Upload a watermark
Delete Delete /watermarks/{watermarkId} Delete a watermark
List Get /watermarks List all watermarks

Webhooks

Retrieve an instance of the Webhooks API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
webhooksApi := client.Webhooks
Endpoints
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

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.