Get Ugc Job Status Tool
get_ugc_job_statusGet the status of a UGC generation job by its ugc_job id (a hashid returned by
generate_ugc). Returns status, one of: queued, rendering (in-flight -- keep
polling) or completed, failed (terminal -- stop polling).
Always returns progress (0-100) and progress_step (the current render stage, e.g.
start_frame, rendering, encoding), updated live from the worker while rendering,
so you can report a real percentage to the user between polls.
When completed it returns video_url (a downloadable GET URL for the generated
clip), share_url (a short, stable openclip.app/c/ link that redirects to the clip
and never expires -- give this to a human to share), and result_meta (e.g. duration,
dims, fps, seed). When failed it returns error.
Poll about every 10-15s; UGC renders are heavy and can take a couple of minutes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ugc_job | Yes | The UGC job id (hashid) returned by generate_ugc. |