offload.runoffload.run

Quick Start

Get your first job running in under 5 minutes.

1. Install the SDK

Install the offload.run SDK using your preferred package manager.

npm install @offload-run/sdk

2. Initialize the Client

Import the SDK and initialize it with your API key. You can find your API key in the dashboard.

import { Offload } from '@offload-run/sdk';

const offload = new Offload({
  apiKey: process.env.OFFLOAD_API_KEY,
});

3. Enqueue a Job

Submit a job to the processing queue. Here's an example of compressing a video.

const job = await offload.enqueue('compress-video', {
  input: 'https://example.com/my-video.mp4',
  options: {
    quality: 'high',
    format: 'mp4'
  }
});

console.log('Job ID:', job.id);
Explore API Reference