offload.runoffload.run

API Reference

Comprehensive reference for the offload.run API.

Base URL

All API requests should be made to the following base URL:

https://app.offload.run/api/v1

Authentication

Authenticate your requests by including your API key in the x-api-key header.

x-api-key: YOUR_API_KEY

We recommend using the official SDK which handles authentication automatically.

Endpoints

POST /jobs
Enqueue a new processing job.
Job
GET /jobs/:id
Get the status and result of a job.
Status
DELETE /jobs/:id
Cancel a pending or processing job.
Cancel

Job Types

Supported job types for media processing:

videoThumbnailExtract thumbnail from video
compressImageCompress and optimize images
compressVideoCompress videos for web
compressPdfCompress PDF documents
extractAudioExtract audio from video as MP3