Get rendering progress for a B-roll job - YALG Developer Docs

Get rendering progress for a B-roll job

curl --request GET \
  --url https://api.yalg.ai/v1/broll/{id}/progress \
  --header 'x-api-key: <api-key>'

{
  "status": "running",
  "currentStep": "rendering",
  "progress": 0.65,
  "message": "Generation is in progress",
  "updatedAt": "2026-06-20T17:24:39.000Z"
}

GET

/

v1

/

broll

/

{id}

/

progress

Get rendering progress for a B-roll job

curl --request GET \
  --url https://api.yalg.ai/v1/broll/{id}/progress \
  --header 'x-api-key: <api-key>'

{
  "status": "running",
  "currentStep": "rendering",
  "progress": 0.65,
  "message": "Generation is in progress",
  "updatedAt": "2026-06-20T17:24:39.000Z"
}

Authorizations

x-api-key

string

header

default:yalg_live_your_api_key

required

YALG Developer API key. Send it in the x-api-key header from a server-side environment only.

Path Parameters

id

string

required

Resource identifier.

Example:

"018f9f40-7d7b-7712-9b0f-2e5d9fd5df3f"

Response

Progress data

Status or progress payload for an asynchronous YALG workflow.

status

string

Example:

"running"

currentStep

string

Example:

"rendering"

progress

number

Example:

0.65

message

string

Example:

"Generation is in progress"

updatedAt

string<date-time>

Example:

"2026-06-20T17:24:39.000Z"

⌘I