What this API does

Returns processing jobs owned by the authenticated user
Supports pagination using page and limit
Allows filtering by avatar, process type, and status
Includes real-time progress and execution metadata
Jobs are ordered by most recent first

Authentication

https://buildvr.gretxp.com/profile/api-credentials

Headers

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

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Jobs per page (default: 10)
upload_id	integer	No	Filter jobs by uploaded video (avatar)
process_type	string	No	Filter by conversion mode
status	string	No	Filter by job status

Example Request

GET /processing-jobs?page=1&limit=10&status=processing

Job Status Values

Status	Status Name	Description
`queued`	Queued	Waiting to be picked up by workers
`created`	Created	Job record created
`processing`	Processing	Conversion is actively running
`completed`	Completed	Conversion completed successfully
`failed`	Failed	Conversion failed after retries

Process Types (Conversion Modes)

Mode	Description
`depthmap`	Depth map generation
`hevc`	HEVC master encoding
`fisheye`	Fisheye projection
`fulldome`	Full-dome fisheye projection

Response

200 OK

{
  "success": true,
  "jobs": [
    {
      "id": 512,
      "upload_id": 981,
      "process_type": "hevc",
      "target_resolution": "5.7k",
      "target_bitrate_mbps": 60,
      "status": "processing",
      "status_name": "Processing",
      "progress": 45,
      "progress_message": "Encoding video 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
    }
  ],
  "total_pages": 3,
  "current_page": 1,
  "next_page": 2,
  "count": 27
}

Job Object Fields

Field	Description
progress	Completion percentage (0–100)
progress_message	Human-readable status update
output_url	Download URL when job is completed
error_log	Error details if the job failed
retry_count	Number of retry attempts
max_retry_count	Maximum retries allowed
total_runtime	Total execution time in seconds

Progress updates may be delayed by a few seconds
Output URL is populated only after completion
Failed jobs may be retried until max retry count is reached

Possible Errors

400 – Invalid pagination or filter values
403 – Invalid API credentials
500 – Internal server error

👉 Next: Job Detail – inspect a single processing job in detail.