API v1

Job Status

Fetches the real-time status and execution details of a specific video processing job.

GET/api/client/v1/processing-jobs/{job_id}

What this API does

  • Returns detailed status of a single processing job
  • Provides real-time progress and status messages
  • Includes output URL when processing is complete
  • Returns error information if the job failed

Authentication

Headers
X-Client-ID: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

Path Parameter

ParameterTypeRequiredDescription
job_idstring / integerYesUnique identifier of the processing job
Example Request
GET /processing-jobs/512

Job Status Lifecycle

queued → created → processing → completed ↘ failed

Progress updates are reported while the job is in the processing state.

Response

200 OK
{
  "success": true,
  "job": {
    "id": 512,
    "upload_id": 981,
    "process_type": "hevc",
    "target_resolution": "5.7k",
    "target_bitrate_mbps": 60,
    "status": "processing",
    "status_name": "Processing",
    "progress": 68,
    "progress_message": "Encoding HEVC stream",
    "output_url": null,
    "error_log": null,
    "retry_count": 1,
    "max_retry_count": 3,
    "created_at": "2026-01-12T09:15:00Z",
    "started_at": "2026-01-12T09:16:10Z",
    "finished_at": null,
    "total_runtime": null
  }
}

Job Object Fields

FieldDescription
statusMachine-readable job state
status_nameHuman-readable job state
progressCompletion percentage (0–100)
progress_messageCurrent execution step
output_urlDownload URL when completed
error_logError details if job fails
retry_countNumber of retry attempts
max_retry_countMaximum retries allowed
total_runtimeTotal processing time (seconds)
  • Clients may poll this endpoint to track progress
  • Output URL is populated only after completion
  • Error log is present only if status is failed

Possible Errors

  • 400 – job_id is missing
  • 403 – Invalid API credentials
  • 404 – Job not found or access denied
  • 500 – Internal server error

👉 Next: Retry Job – retry a failed processing job.