Sign up for free

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

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
MethodHTTP requestDescription
GetAggregatedMetricsGet /data/metrics/\{metric}/{aggregation}Retrieve aggregated metrics
GetMetricsBreakdownGet /data/buckets/\{metric}/{breakdown}Retrieve metrics in a breakdown of dimensions
GetMetricsOverTimeGet /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
MethodHTTP requestDescription
UploadPost /videos/\{videoId}/captions/{language}Upload a caption
GetGet /videos/\{videoId}/captions/{language}Retrieve a caption
UpdatePatch /videos/\{videoId}/captions/{language}Update a caption
DeleteDelete /videos/\{videoId}/captions/{language}Delete a caption
ListGet /videos/\{videoId}/captionsList video captions

Chapters

Retrieve an instance of the Chapters API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
chaptersApi := client.Chapters
Endpoints
MethodHTTP requestDescription
UploadPost /videos/\{videoId}/chapters/{language}Upload a chapter
GetGet /videos/\{videoId}/chapters/{language}Retrieve a chapter
DeleteDelete /videos/\{videoId}/chapters/{language}Delete a chapter
ListGet /videos/\{videoId}/chaptersList video chapters

LiveStreams

Retrieve an instance of the LiveStreams API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
liveStreamsApi := client.LiveStreams
Endpoints
MethodHTTP requestDescription
CreatePost /live-streamsCreate live stream
GetGet /live-streams/{liveStreamId}Retrieve live stream
UpdatePatch /live-streams/{liveStreamId}Update a live stream
DeleteDelete /live-streams/{liveStreamId}Delete a live stream
ListGet /live-streamsList all live streams
UploadThumbnailPost /live-streams/\{liveStreamId}/thumbnailUpload a thumbnail
DeleteThumbnailDelete /live-streams/\{liveStreamId}/thumbnailDelete a thumbnail
CompletePut /live-streams/\{liveStreamId}/completeComplete a live stream

PlayerThemes

Retrieve an instance of the PlayerThemes API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
playerThemesApi := client.PlayerThemes
Endpoints
MethodHTTP requestDescription
CreatePost /playersCreate a player
GetGet /players/{playerId}Retrieve a player
UpdatePatch /players/{playerId}Update a player
DeleteDelete /players/{playerId}Delete a player
ListGet /playersList all player themes
UploadLogoPost /players/\{playerId}/logoUpload a logo
DeleteLogoDelete /players/\{playerId}/logoDelete logo

Tags

Retrieve an instance of the Tags API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
tagsApi := client.Tags
Endpoints
MethodHTTP requestDescription
ListGet /tagsList all video tags

UploadTokens

Retrieve an instance of the UploadTokens API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
uploadTokensApi := client.UploadTokens
Endpoints
MethodHTTP requestDescription
CreateTokenPost /upload-tokensGenerate an upload token
GetTokenGet /upload-tokens/{uploadToken}Retrieve upload token
DeleteTokenDelete /upload-tokens/{uploadToken}Delete an upload token
ListGet /upload-tokensList all active upload tokens

Videos

Retrieve an instance of the Videos API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
videosApi := client.Videos
Endpoints
MethodHTTP requestDescription
CreatePost /videosCreate a video object
UploadPost /videos/\{videoId}/sourceUpload a video
UploadWithUploadTokenPost /uploadUpload with an delegated upload token
GetGet /videos/{videoId}Retrieve a video object
UpdatePatch /videos/{videoId}Update a video object
DeleteDelete /videos/{videoId}Delete a video object
ListGet /videosList all video objects
UploadThumbnailPost /videos/\{videoId}/thumbnailUpload a thumbnail
PickThumbnailPatch /videos/\{videoId}/thumbnailSet a thumbnail
GetDiscardedGet /discarded/videos/{videoId}Retrieve a discarded video object
GetStatusGet /videos/\{videoId}/statusRetrieve video status and details
ListDiscardedGet /discarded/videosList all discarded video objects
UpdateDiscardedPatch /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
MethodHTTP requestDescription
UploadPost /watermarksUpload a watermark
DeleteDelete /watermarks/{watermarkId}Delete a watermark
ListGet /watermarksList all watermarks

Webhooks

Retrieve an instance of the Webhooks API:
client := apivideosdk.ClientBuilder("API_VIDEO_KEY").Build()
webhooksApi := client.Webhooks
Endpoints
MethodHTTP requestDescription
CreatePost /webhooksCreate Webhook
GetGet /webhooks/{webhookId}Retrieve Webhook details
DeleteDelete /webhooks/{webhookId}Delete a Webhook
ListGet /webhooksList 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.

Was this page helpful?