Skip to content

Create asset embeddable links

Request

An AssetEmbeddableLinkBatchJob should be created when you want to create embeddable links for multiple AssetFile resources.

There is a limit of 500 batch request items for this endpoint. If more than 500 items are requested, the endpoint will error with a bad request(400) response.

The transformationDescription can be one of two types, CUSTOM or PRESET.

This definition and usage matches the transformationDescription used in AssetDownloadBatchJob.

A CUSTOM transformationDescription is a list of candidateTransformations which are evaluated in turn against each AssetFile specified in the request. If the AssetFile meets the candidateTransformation.criteria then the candidateTransformation.transformation is applied. Otherwise, the next candidate is considered. The candidateTransformation.transformation is a series of operations to apply to the AssetFile in order (e.g. resize to 200 by 100 and then covert to JPG). An empty list of operations indicates the file should be left untransformed.

A PRESET transformationDescription is similar to a CUSTOM transformation except the transformationDescription has been predefined. These presets are currently only configurable via the Dash frontend, but can be found via a PresetTransformationSearch.

Security
bearerToken
Bodyapplication/jsonrequired
itemsArray of objectsrequired
transformationDescriptionanyrequired
curl -i -X POST \
  https://api-v2.dash.app/embeddable-link-batch-jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "batchItemId": "my-item-1",
        "assetId": "7af90a8b-7ccd-430f-a85d-e8614015bc47",
        "assetFileId": "7af90a8b-7ccd-430f-a85d-e8614015bc47",
        "presetParameters": []
      }
    ],
    "transformationDescription": {
      "type": "CUSTOM",
      "candidateTransformations": [
        {
          "criteria": [
            {
              "type": "MATCHES_MEDIA_TYPES",
              "mediaTypes": [
                {}
              ]
            }
          ],
          "transformation": []
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the job that has been created

Example:"be161977-d44e-4888-af3c-66522e223963"
accountIdstringrequired

The ID of the account the job is happening in

Example:"cfb665ca-ce35-4418-b9d5-70ee815db4bd"
creatorIdstringrequired

The ID of the User who created the job

Example:"google-oauth2|110955770826801837334"
typestringrequired

The job type

Value:"IN_PROGRESS"
Discriminator
progressobjectrequired
statusstringrequired
Enum:"PENDING""STARTING""STARTED""STOPPING"
Response
{
  "id": "be161977-d44e-4888-af3c-66522e223963",
  "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
  "creatorId": "google-oauth2|110955770826801837334",
  "type": "IN_PROGRESS",
  "status": "PENDING",
  "progress": {
    "steps": [ … ]
  }
}