FastPix Go SDK

The FastPix Go SDK is a strongly typed Go client for the FastPix video API. From any Go application you can upload and manage videos, run live streams and simulcasts, create and secure playback IDs, manage playlists and signing keys, pull video analytics, and use in-video AI features.

Find more in the SDK reference

For all methods, runnable examples, and advanced usage, see the FastPix Go SDK on GitHub.

Before you begin

Make sure you have:

• Go 1.21 or later
• Go Modules enabled
• Internet access
• A FastPix account
• A FastPix Access Token and Secret Key, generated from the FastPix Dashboard. See Activate your account.

FastPix uses HTTP Basic Authentication. The SDK maps your credentials as follows:

Security: Never commit your Access Token or Secret Key to source control. Use environment variables or a secure credential-management system.

Follow the steps below in order, and do not skip the verification steps. If installation, import, authentication, client initialization, or the first API request fails, fix that problem before continuing.

Check your Go version

go version

The output is similar to go version go1.21.0 darwin/arm64 or a later version. The SDK supports Go 1.21 and later. If your version is earlier than 1.21, install a supported version before continuing.

Create a Go project

Create a directory for your application and initialize a Go module:

mkdir fastpix-go-demo
cd fastpix-go-demo
go mod init fastpix-go-demo

go mod init creates a go.mod file that tracks your module name and dependencies.

Install the FastPix SDK

Install the FastPix Go SDK with Go Modules:

go get github.com/FastPix/fastpix-go

Go downloads the SDK and adds it to your dependencies. Confirm the dependency:

go list -m github.com/FastPix/fastpix-go

The output lists the module and the installed version.

Verify the SDK installation

Confirm that your Go project can import the SDK. Create a file named main.go:

package main
import (
	"fmt"
	fastpixgo "github.com/FastPix/fastpix-go"
)
func main() {
	_ = fastpixgo.New
	fmt.Println("FastPix SDK imported successfully")
}

Run it:

go run .

The expected output is FastPix SDK imported successfully. If it fails, confirm that Go 1.21 or later is installed, the module is initialized, github.com/FastPix/fastpix-go is listed in go.mod, and you are running the command from the project directory. If needed, run go mod tidy and try again.

Configure authentication

FastPix uses HTTP Basic Authentication, where Username is your Access Token and Password is your Secret Key. For local development, set these as environment variables so they stay out of your source code:

# macOS and Linux
export FASTPIX_USERNAME="<YOUR_ACCESS_TOKEN>"
export FASTPIX_PASSWORD="<YOUR_SECRET_KEY>"

# Windows PowerShell
$env:FASTPIX_USERNAME="<YOUR_ACCESS_TOKEN>"
$env:FASTPIX_PASSWORD="<YOUR_SECRET_KEY>"

Verify that your credentials are set

Check that both variables are set without printing their values:

# macOS and Linux
if [ -n "$FASTPIX_USERNAME" ]; then echo "Access Token: set"; else echo "Access Token: missing"; fi
if [ -n "$FASTPIX_PASSWORD" ]; then echo "Secret Key: set"; else echo "Secret Key: missing"; fi

Both should report set. If either is missing, set the corresponding environment variable before continuing.

Initialize the FastPix client

Replace main.go with:

package main
import (
	"context"
	"fmt"
	"os"
	fastpixgo "github.com/FastPix/fastpix-go"
	"github.com/FastPix/fastpix-go/models/components"
)
func main() {
	ctx := context.Background()
	fastpix := fastpixgo.New(
		fastpixgo.WithSecurity(components.Security{
			Username: fastpixgo.Pointer(os.Getenv("FASTPIX_USERNAME")),
			Password: fastpixgo.Pointer(os.Getenv("FASTPIX_PASSWORD")),
		}),
	)
	_ = ctx
	_ = fastpix
	fmt.Println("FastPix client initialized")
}

Run it:

go run .

The expected output is FastPix client initialized. Initializing the client does not make an API request; a request happens only when you call an operation such as fastpix.InputVideo.Create(...).

Make your first API request

The easiest way to verify the integration is to create media from a publicly accessible video URL. FastPix provides a sample video at https://static.fastpix.com/fp-sample-video.mp4.

Replace main.go with:

package main
import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"
	fastpixgo "github.com/FastPix/fastpix-go"
	"github.com/FastPix/fastpix-go/models/components"
)
func main() {
	ctx := context.Background()
	fastpix := fastpixgo.New(
		fastpixgo.WithSecurity(components.Security{
			Username: fastpixgo.Pointer(os.Getenv("FASTPIX_USERNAME")),
			Password: fastpixgo.Pointer(os.Getenv("FASTPIX_PASSWORD")),
		}),
	)
	response, err := fastpix.InputVideo.Create(
		ctx,
		components.CreateMediaRequest{
			Inputs: []components.Input{
				components.CreateInputPullVideoInput(
					components.PullVideoInput{
						URL: fastpixgo.Pointer(
							"https://static.fastpix.com/fp-sample-video.mp4",
						),
					},
				),
			},
			Metadata: map[string]string{
				"source": "fastpix-go-demo",
			},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	if response.CreateMediaSuccessResponse == nil {
		log.Fatal("FastPix API did not return a successful media response")
	}
	output, err := json.MarshalIndent(
		response.CreateMediaSuccessResponse,
		"",
		"  ",
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(output))
}

Run it:

go run .

A successful request returns information about the newly created media asset, similar to:

{
  "success": true,
  "data": {
    "id": "..."
  }
}

The exact fields depend on the API response and the installed SDK version. A media_id is not the same as a playback_id. They identify different resources and are used for different operations.

Retrieve the media asset

Use the media ID returned by the create operation to retrieve the media asset. The Go SDK exposes this through fastpix.Videos.Get(ctx, mediaID). Replace main.go with:

package main
import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"
	fastpixgo "github.com/FastPix/fastpix-go"
	"github.com/FastPix/fastpix-go/models/components"
)
func main() {
	ctx := context.Background()
	fastpix := fastpixgo.New(
		fastpixgo.WithSecurity(components.Security{
			Username: fastpixgo.Pointer(os.Getenv("FASTPIX_USERNAME")),
			Password: fastpixgo.Pointer(os.Getenv("FASTPIX_PASSWORD")),
		}),
	)
	// Create media.
	fmt.Println("Creating media...")
	createResponse, err := fastpix.InputVideo.Create(
		ctx,
		components.CreateMediaRequest{
			Inputs: []components.Input{
				components.CreateInputPullVideoInput(
					components.PullVideoInput{
						URL: fastpixgo.Pointer(
							"https://static.fastpix.com/fp-sample-video.mp4",
						),
					},
				),
			},
			Metadata: map[string]string{
				"source": "fastpix-go-demo",
			},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	if createResponse.CreateMediaSuccessResponse == nil {
		log.Fatal("FastPix API did not return a successful media response")
	}
	createData := createResponse.CreateMediaSuccessResponse
	output, err := json.MarshalIndent(createData, "", "  ")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("\nCREATE MEDIA")
	fmt.Println(string(output))
	// Carry the media ID from create into the next call.
	mediaID := createData.Data.Id
	fmt.Println("\nMEDIA ID:")
	fmt.Println(mediaID)
	// Retrieve the media.
	fmt.Println("\nRetrieving media...")
	mediaResponse, err := fastpix.Videos.Get(ctx, mediaID)
	if err != nil {
		log.Fatal(err)
	}
	if mediaResponse.Object == nil {
		log.Fatal("FastPix API did not return media data")
	}
	mediaOutput, err := json.MarshalIndent(
		mediaResponse.Object,
		"",
		"  ",
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("\nGET MEDIA")
	fmt.Println(string(mediaOutput))
}

Run it:

go run .

A successful response from the get-media operation confirms that the SDK authenticated, the media was created, a media ID was returned, and the media ID can be used in a subsequent API operation.

Verify the integration

A successful create-then-get flow confirms that Go is installed and supported, Go Modules are configured, the SDK is installed and importable, your credentials are configured, the client can authenticate, and you can create and retrieve a media asset.

Creating media is usually the first step in a FastPix on-demand workflow: you create the media, poll it until processing finishes, then create a playback ID to play it. The initial SDK integration is now complete.

Resources, error handling, and reference

The SDK is generated from the FastPix API specification, so the complete and always-current reference lives in the repo and the API docs:

• All resources, operations, error handling, retries, server selection, and custom HTTP clients: the FastPix Go SDK on GitHub, with runnable code in the examples directory.
• Media (upload, manage, playback, playlists, signing keys, DRM): Video on Demand API.
• Live (streams, simulcasts, live playback): Live Stream API.
• Video Data (metrics, views, dimensions, errors): Video Data API.
• In-video AI (summaries, chapters, named entities, moderation): In-Video AI.

What’s next

Want to go further? Browse runnable, end-to-end samples for the FastPix Go SDK in the examples folder of the GitHub repository.

Release notes

For a complete history of releases, improvements, and fixes, see the FastPix Go SDK CHANGELOG on GitHub.