Sign in

v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Get public links

Generate an embed or download link to multiple assets

post/getlinks_45W_v1

Request body

RecordIDstring

The record ID of an asset.<br>This parameter <b>or</b> the Identifier parameter is required.

Identifierstring

The <a href="https://developer.orangelogic.com/reference/assets">Unique Identifier</a> of an asset.<br>This parameter <b>or</b> the RecordID parameter is required.

Formatstring

The code of the <a href="https://developer.orangelogic.com/reference/assets#formats">asset format</a> that you want to generate a link for (TRX, TR1, etc.).

LogViewsboolean

Whether OrangeDAM logs each view or download. Administrators can view this information in the Full logs of views and downloads. Orange Logic users with a Link account can go to the <a href="https://link.orangelogic.com/CMS4/Permalinks/2P7YOHA7V1MI" target="_blank">Full logs of views and downloads</a> article to learn more.

CreateDownloadLinkboolean

<code>True</code>: The link downloads the assets.</br><code>False</code>: The link will be an embed link.

ExpirationDatestring

An expiration date in the <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format: "YYYY-MM-DDTHH:MM:SS.SSSZ" The [<i>sss</i>] value is optional. It represents the <a href="https://en.wikipedia.org/wiki/UTC_offset" target="_blank">UTC offset</a>. Example: "2024-10-31T13:44:39.735Z"

MaxWidthinteger

The maximum width of the assets.<br>If you are generating transformations, the transformation crop or resize takes precedence over <code>MaxWidth</code>.

MaxHeightinteger

The maximum height of the assets.<br>If you are generating transformations, the transformation crop or resize takes precedence over <code>MaxHeight</code>.

FileExtensionstring

The file extension of the assets (.jpeg, .png, etc.).

ImageResizingMethod'Fit' | 'Stretch' | 'NorthwestCrop' | 'NorthCrop' | 'NortheastCrop' | 'WestCrop' | 'CenterCrop' | 'EastCrop' | 'SouthwestCrop' | 'SouthCrop' | 'SoutheastCrop' | 'OpticalCrop' | 'AICrop'

Resizes the image's aspect ratio based on <code>Maxwidth</code> and <code>MaxHeight</code>.

Transformationsstring[]

Enter a string for each transformation you want to apply to the asset. Transformations are applied in the order in which they appear in the string and take precedence over <code>Maxwidth</code> and <code>MaxHeight</code>.<br>This parameter is available beginning in <a href="https://link.orangelogic.com/CMS4/Permalinks/2P7YOHY7FJDO" target="_blank">Orange Logic Kobe</a>.<br>See the <a href="https://developer.orangelogic.com/reference/transformation-example">transformation example</a> for more information.

Titlestring

Title of the asset link

CustomAccessKeystring

Enter a <a href="https://developer.orangelogic.com/reference/assets">custom access key</a> to use for the generated link. If this is not specified, the link will have a random access key.

IsVideoboolean

Set to true if the asset is a video.

Response

200

Example response

{
  "assetLinks": [
    {
      "recordID": "2QDTWAGCCFF",
      "identifier": "ZZ13GMR",
      "format": "TR1",
      "link": "https://mangovations.com/AssetLink/j387f16851706vwvox5rqkw75s4bn34e-2000x2000,.jpeg",
      "maxWidth": 2000,
      "maxHeight": 2000,
      "expirationDate": "2028-12-31T23:59:59",
      "fileExtension": ".jpeg"
    }
  ]
}