Get Render Status

Check the status of a render job

Endpoint

POST https://api.ugc.inc/render/status

Overview

Check the status of a render job submitted via /render/submit. Poll this endpoint until the status is completed or failed.

Request Body

job_id · string · required

The job ID returned from the submit endpoint

Response

data · object

Job status information

Show Status properties

job_id · string

The job identifier

status · string

Current job status

• pending: Job queued, waiting to start
• processing: Job is currently rendering
• completed: Job finished successfully
• failed: Job encountered an error

output_type · 'video' | 'image'

Type of output being rendered

progress · number

Progress percentage (0-100)

message · string

Status message describing current state

created_at · number

Job creation timestamp (Unix time)

updated_at · number

Last update timestamp (Unix time)

download_url · string

Download URL for the rendered file (only present when status: 'completed')

size_bytes · number

File size in bytes (only present when completed)

duration_ms · number

Total render time in milliseconds (only present when completed, video only)

stats · object

Detailed timing breakdown (only present when completed)

Show Stats properties

preload_ms · number

Time spent loading media files

audio_ms · number

Time spent mixing audio

render_ms · number

Time spent rendering frames

encode_ms · number

Time spent encoding final output

total_ms · number

Total processing time

completed_at · number

Completion timestamp (only present when completed)

error · string

Error message (only present when failed)

cURL

curl -X POST https://api.ugc.inc/render/status \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id": "550e8400-e29b-41d4-a716-446655440000"}'

Processing

{
  "ok": true,
  "code": 200,
  "message": "Success",
  "data": {
    "job_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "processing",
    "output_type": "video",
    "progress": 45,
    "message": "Rendering frames...",
    "created_at": 1700000000.123,
    "updated_at": 1700000015.456
  }
}