Wistia TypeScript SDK
Developer-friendly TypeScript SDK specifically catered to leverage the Wistia API.
## Summary
The Wistia TypeScript SDK provides comprehensive programmatic access to the Wistia Data, stats, and upload API, enabling developers to integrate with Wistia's video hosting and marketing platform. The SDK supports core video management operations including media upload, organization within projects and subfolders, caption and localization management, analytics and stats retrieval, live streaming events, and domain security controls.
## Server-side only
**Important:** Please do not use this library in a client context, as exposing bearer tokens in client-side applications is inherently insecure.
## Official docs
For complete API documentation and platform guides, please visit [docs.wistia.com](https://docs.wistia.com).
## Version note
This SDK wrapper is currently in **beta**; functionality is subject to change. When released, the API will use a date-based versioning system instead of (but compliant with) SemVer.
## Table of Contents
* [Server-side only](#server-side-only)
* [Official docs](#official-docs)
* [Version note](#version-note)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [File uploads](#file-uploads)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## SDK Installation
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
### NPM
```bash
npm add @wistia/wistia-api-client
```
### PNPM
```bash
pnpm add @wistia/wistia-api-client
```
### Bun
```bash
bun add @wistia/wistia-api-client
```
### Yarn
```bash
yarn add @wistia/wistia-api-client
```
> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Example Usage
### Example
```typescript
import { Wistia } from "@wistia/wistia-api-client";
const wistia = new Wistia({
bearerAuth: process.env["WISTIA_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await wistia.media.uploadForm({
url:
"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
lowPriority: true,
});
console.log(result);
}
run();
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| ------------ | ---- | ----------- | -------------------- |
| `bearerAuth` | http | HTTP Bearer | `WISTIA_BEARER_AUTH` |
To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { Wistia } from "@wistia/wistia-api-client";
const wistia = new Wistia({
bearerAuth: process.env["WISTIA_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await wistia.media.uploadForm({
url:
"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
lowPriority: true,
});
console.log(result);
}
run();
```
## Available Resources and Operations