Queue Events (SSE)

Endpoint

GET /queue/events

Auth: Public (rate limited) This endpoint opens a persistent HTTP connection and streams job lifecycle events as they happen. Use this to show real-time upload/processing progress in your UI without polling.

Response headers

Header	Value
`Content-Type`	`text/event-stream`
`Cache-Control`	`no-cache`
`Connection`	`keep-alive`
`X-Accel-Buffering`	`no`

Events

Each event follows the SSE format: event: <type>\ndata: <json>\n\n

`connected`

Sent immediately on connection.

event: connected
data: {"clientId": "client_abc123"}

`job:created`

A new transformation job was added to the queue.

event: job:created
data: {
  "jobId": "job_xyz",
  "filePath": "videos/clip.mp4",
  "status": "pending",
  "priority": 1
}

`job:started`

A job began processing.

event: job:started
data: {
  "jobId": "job_xyz",
  "filePath": "videos/clip.mp4",
  "status": "running"
}

`job:progress`

Processing progress update (0–100).

event: job:progress
data: {
  "jobId": "job_xyz",
  "progress": 47
}

`job:completed`

Job finished successfully.

event: job:completed
data: {
  "jobId": "job_xyz",
  "filePath": "videos/clip.mp4",
  "status": "completed"
}

`job:error`

Job failed.

event: job:error
data: {
  "jobId": "job_xyz",
  "filePath": "videos/clip.mp4",
  "status": "error",
  "error": "FFmpeg process exited with code 1"
}

`heartbeat`

Periodic keep-alive event to prevent connection timeouts.

event: heartbeat
data: {"timestamp": 1710498600000}

timestamp is a Unix epoch time in milliseconds (Date.now()), not an ISO string.

Usage example

JavaScript (browser)
curl

const source = new EventSource('http://localhost:3000/queue/events');

source.addEventListener('connected', (e) => {
  const { clientId } = JSON.parse(e.data);
  console.log('Connected:', clientId);
});

source.addEventListener('job:progress', (e) => {
  const { jobId, progress } = JSON.parse(e.data);
  console.log(`Job ${jobId}: ${progress}%`);
  updateProgressBar(jobId, progress);
});

source.addEventListener('job:completed', (e) => {
  const { jobId } = JSON.parse(e.data);
  console.log('Done:', jobId);
});

source.addEventListener('job:error', (e) => {
  const { jobId, error } = JSON.parse(e.data);
  console.error(`Job ${jobId} failed:`, error);
});

curl -N http://localhost:3000/queue/events

Queue Jobs

Query job details or manage individual jobs.

Video Status

Check processing status by file path.

Overview

Media

Files

Storage

Cache

Video Processing

API Keys

System

Endpoint

Response headers

Events

`connected`

`job:created`

`job:started`

`job:progress`

`job:completed`

`job:error`

`heartbeat`

Usage example

Queue Jobs

Video Status

​Endpoint

​Response headers

​Events

​connected

​job:created

​job:started

​job:progress

​job:completed

​job:error

​heartbeat

​Usage example

​Related

Queue Jobs

Video Status

Endpoint

Response headers

Events

`connected`

`job:created`

`job:started`

`job:progress`

`job:completed`

`job:error`

`heartbeat`

Usage example

Related