Generate or regenerate proxies

The <a href="https://developer.orangelogic.com/reference/assets">Unique Identifier</a> of an asset.<ul><li>Enter <code>*</code> to generate proxies for all assets.<br><b>❗ Warning: </b>Generating or regenerating a large number of proxies can take a significant amount of system resources. Review <a href="https://developer.orangelogic.com/reference/generate-or-regenerate-proxies#proxyWarning">our recommendations</a> and submit a support request if you’d like to consult with the Orange Logic support team before you generate or regenerate a large number of proxies.<br></li><li>Enter a comma-separated list of IDs to generate proxies for multiple assets.</li><li>Enter <code>temptable</code> to generate proxies for the assets identified in a table. Enter the table name in the <code>IdentifiersTableName</code> parameter.</li><ul>

The code of the proxy format to generate. When you specify a proxy format, you must also specify an asset type in the <code>DocType</code> parameter.<ul><li>Enter a pipe-delimited list to generate multiple proxy formats. <br><b>Example</b>: CMS1|TR10|WebHigh</li><li>If you don’t specify formats, all formats are generated.</li></ul>ℹ️ <b>Note</b><p>This parameter is not required. However, we highly recommend specifying one or more formats. In most cases, generating all formats is unnecessary and takes time, processing bandwidth, and storage space that could be better used for other tasks.

The asset <a href=”https://developer.orangelogic.com/reference/assets#asset-type-and-subtype>type or subtype</a>. <b>Required when the <code>FileFormat</code> parameter is used.</b>

The priority of the proxy generation task in the <<glossary:application queue>>. By default, the task is scheduled in the very low priority queue.

Whether the Orange Logic platform generates a proxy when the relevant format already exists.<ul><li><code>TheFormatExists</code>: When the relevant proxy format already exists for an asset, the proxy is regenerated. If the proxy format doesn’t exist, a new proxy is <b><i>not</b></i> generated.</li><li><code>TheFormatDoesntExist</code>: When the relevant proxy format doesn’t exist for an asset, the proxy is generated. If the proxy format already exists, the proxy is not regenerated.</li><li>If you don’t specify a value, the relevant proxy format is always generated or regenerated.</li></ul>ℹ️ <b>Note</b><p>This parameter is supported only for audio and video assets. It is not supported for images, so image proxies are always generated or regenerated.

Set to <code>true</code> to regenerate any proxy used as the <glossary:representative> of the asset. This proxy regeneration will happen regardless of any other settings, such as the specified proxy format.

Set to <code>true</code> to update media data in the database before generating proxies. This option is useful when ingest errors resulted in incorrect media data in the database.</p><p>Media data is the following information:<br><ul><li>For images: width, height</li><li>For audio: width, height, duration, bit rate, frame rate, format</li><li>For video: duration, bit rate, format</li></ul></p>

Enter a transaction record ID to add the proxy generation task to an existing asynchronous transaction.

The response format (XML or JSON)

The output <a href="https://developer.orangelogic.com/reference/date-and-time">date format</a>

An authentication token. If empty, the token included in the current cookie is used.

The name of the table in which asset identifiers are stored. Use this parameter only when the <code>AssetIdentifier</code> parameter is set to <code>temptable</code>.<p>For example, you could run the <b>/api/Documents/v1.0/CheckIncorrectProfileImages</b> call to generate a list of images that are the wrong color due to a missing profile. The response to this call is the name of a table storing the <a href=”https://developer.orangelogic.com/reference/assets#record-id”>record IDs</a> of the affected assets. Enter the table name in this parameter to regenerate the proxies of those assets.