Queue Jobs

List jobs

GET /queue/jobs

Auth: API Key required

Query parameters

limit

number

default:"50"

Maximum number of jobs to return (pagination).

offset

number

default:"0"

Number of jobs to skip (pagination offset).

status

string

Filter by job status. One of: pending, running, completed, error, cancelled.

Response

{
  "jobs": [
    {
      "id": "job_abc123",
      "filePath": "videos/clip.mp4",
      "status": "completed",
      "priority": 1,
      "progress": 100,
      "startedAt": "2024-03-15T10:30:00.000Z",
      "completedAt": "2024-03-15T10:31:45.000Z",
      "error": null
    }
  ],
  "limit": 50,
  "offset": 0,
  "count": 1
}

jobs

array

Show Job object

string

Unique job identifier.

filePath

string

Storage path of the video being processed.

status

string

pending · running · completed · error · cancelled

priority

number

Processing priority (lower = higher priority).

progress

number

Progress percentage (0–100).

startedAt

string

ISO 8601 timestamp when processing started.

completedAt

string

ISO 8601 timestamp when processing finished.

error

string

Error message if status is error.

count

number

Total jobs in the current result set.

Example

# List all failed jobs
curl "http://localhost:3000/queue/jobs?status=error&limit=20" \
  -H "Authorization: Bearer <api_key>"

Retry job

POST /queue/jobs/{jobId}/retry

Re-queues a failed job for processing. Auth: API Key required

Path parameters

jobId

string

required

ID of the job to retry. Must have error status.

Response

{
  "success": true,
  "message": "Job queued for retry"
}

Status codes: 200 success · 400 job not in error state · 500 error

Example

curl -X POST http://localhost:3000/queue/jobs/job_abc123/retry \
  -H "Authorization: Bearer <api_key>"

Cancel job

POST /queue/jobs/{jobId}/cancel

Cancels a pending job before it starts processing. Auth: API Key required

Path parameters

jobId

string

required

ID of the job to cancel. Must have pending status.

Response

{
  "success": true,
  "message": "Job cancelled"
}

Status codes: 200 success · 400 job not pending · 500 error

Example

curl -X POST http://localhost:3000/queue/jobs/job_abc123/cancel \
  -H "Authorization: Bearer <api_key>"

Delete job

DELETE /queue/jobs/{jobId}

Permanently removes a job record from the queue. Auth: API Key required

Path parameters

jobId

string

required

ID of the job to delete.

Response

{
  "success": true,
  "message": "Job deleted"
}

Status codes: 200 success · 400 failed · 500 error

Example

curl -X DELETE http://localhost:3000/queue/jobs/job_abc123 \
  -H "Authorization: Bearer <api_key>"

Queue Statistics

Aggregate counts per status.

Queue Events (SSE)

Real-time progress updates.

Video Status

Check processing status by file path.

Overview

Media

Files

Storage

Cache

Video Processing

API Keys

System

List jobs

Query parameters

Response

Example

Retry job

Path parameters

Response

Example

Cancel job

Path parameters

Response

Example

Delete job

Path parameters

Response

Example

Queue Statistics

Queue Events (SSE)

Video Status

​List jobs

​Query parameters

​Response

​Example

​Retry job

​Path parameters

​Response

​Example

​Cancel job

​Path parameters

​Response

​Example

​Delete job

​Path parameters

​Response

​Example

​Related

Queue Statistics

Queue Events (SSE)

Video Status

List jobs

Query parameters

Response

Example

Retry job

Path parameters

Response

Example

Cancel job

Path parameters

Response

Example

Delete job

Path parameters

Response

Example

Related