convert_job

TOOLtools/call

Read a Convert job you started: its state, the credits it used and the files it saved. With download: true, each saved file also gets a short-lived download url.

Scopes

execute:convert

Each run spends credits. The key's owner must still hold Run processing when it is used. A job the person or another key started also needs read:files to read. A Convert request or output is never a Design file, so the Files rule for Design files (read:design) does not apply.

Inputs

jobIdstringRequired
downloadboolean

Returns

The job's state, the credits it holds or used (0 once returned) and the files it saved, with short-lived download urls when download is true. A call returns content[0].text with the JSON result and structuredContent.result with the same value.

Listed when

The key holds execute:convert. Each job's tool is listed once the job is set up.