Events and errors
What a running job tells every caller as it goes, and how a request that fails says why.
Events
Every event carries job and path. As a bare object the tag is event;
in the JSON-RPC envelope the tag becomes the notification's method and
the rest its params.
cutout.progress
Payload
fetchingboolrequiredTrue while a model downloads, false while it runs.
fractionnumberrequiredHow far along,
0..=1.jobstringrequiredThe job.
mediaIdstringrequiredThe media being analysed.
pathstringrequiredThe project folder.
stabilize.progress
A stabilized clip's media is being measured ahead of an export.
Payload
fractionnumberrequiredHow far along,
0..=1.jobstringrequiredThe job.
mediaIdstringrequiredThe media being measured.
pathstringrequiredThe project folder.
export.progress
Payload
frameintegerrequiredFrames done.
jobstringrequiredThe job.
pathstringrequiredThe project folder.
stagestringrequired"video", "audio" or "mux".
totalintegerrequiredFrames in total.
export.done
Payload
heightintegerrequiredIts picture size.
jobstringrequiredThe job.
outputstringrequiredThe file written.
pathstringrequiredThe project folder.
widthintegerrequiredIts picture size.
export.failed
Payload
Why:
Cancelledwhen asked to stop, otherwise what went wrong.jobstringrequiredThe job.
pathstringrequiredThe project folder.
Errors
parseThe line was not JSON.
invalidThe JSON was not a request: an unknown method, a missing or ill-typed field, a value out of range.
notOpenThe project named is not open; open it first.
notFoundA job, template or package named does not exist.
refusedThe edit layer said no. The message is the sentence the window would show, and the state is as it was.
busyA one-at-a-time job is already running.
cancelledThe job was stopped by
export.cancel.failedEverything else: a file that could not be read or written, a decode that failed, a model that did not download.
Every error a method replies with is an ApiError.