Introduction

Welcome to the offload.run documentation. Learn how to integrate powerful media processing into your application.

What is offload.run?

Offload.run is a media processing API designed for developers who need to handle video compression, image optimization, and PDF processing at scale. We handle the infrastructure, queuing, and retry logic so you can focus on building your product.

Key Features

  • Video Compression: Compress user-uploaded videos for web playback.
  • Image Optimization: Resize and optimize images for faster load times.
  • PDF Processing: Compress and manipulate PDF documents.
  • Thumbnail Generation: Extract thumbnails from video files.
  • Audio Extraction: Extract audio tracks from video files as MP3.

Official SDK

The easiest way to integrate offload.run is through our official TypeScript/JavaScript SDK. It provides type-safe APIs, built-in webhook verification, and convenient helper methods for common workflows.

Package:@offload-run/sdk
npm install @offload-run/sdk
# or
pnpm add @offload-run/sdk
# or
yarn add @offload-run/sdk

The SDK supports all job types with full TypeScript inference, job polling with waitForJob(), and combined enqueueAndWait() for simple workflows.