Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB
Digital Asset Management (DAM)
Managing assets

Update file details

This API updates the details or attributes of the current version of the file. You can update tags, customCoordinates, customMetadata, publication status, remove existing AITags and apply extensions using this API.

patch/v1/files/{fileId}/details

Path parameters

fileIdstring required

The unique fileId of the uploaded file. fileId is returned in list and search assets API and upload API.

Request body

OR

Example request

{
  "extensions": [
    {
      "name": "remove-bg",
      "options": {
        "add_shadow": true,
        "bg_colour": "green"
      }
    },
    {
      "name": "google-auto-tagging",
      "maxTags": 5,
      "minConfidence": 95
    },
    {
      "name": "ai-auto-description"
    },
    {
      "name": "ai-tasks",
      "tasks": [
        {
          "type": "select_tags",
          "instruction": "What types of clothing items are visible in this image?",
          "vocabulary": [
            "shirt",
            "tshirt",
            "dress",
            "trousers",
            "jacket"
          ]
        },
        {
          "type": "yes_no",
          "instruction": "Is this a luxury or high-end fashion item?",
          "on_yes": {
            "add_tags": [
              "luxury",
              "premium"
            ]
          }
        }
      ]
    },
    {
      "name": "saved-extension",
      "id": "ext_abc123"
    }
  ]
}

Response

Updated file details object.

fileIdstring

Unique identifier of the asset.

type'file' | 'file-version'

Type of the asset.

namestring

Name of the asset.

filePathstring

Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be /file.jpg. If the file is inside a folder named images, the path will be /images/file.jpg.

isPrivateFileboolean

Specifies if the file is private or not.

isPublishedboolean

Specifies if the file is published or not.

urlstring uri

URL of the file.

thumbnailstring uri

URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library.

fileTypestring

Type of the file. Possible values are image, non-image.

mimestring

MIME type of the file.

widthnumber

Width of the file.

heightnumber

Height of the file.

sizenumber

Size of the file in bytes.

bitRateinteger

The bit rate of the video in kbps (only for video).

durationinteger

The duration of the video in seconds (only for video).

audioCodecstring

The audio codec used in the video (only for video/audio).

videoCodecstring

The video codec used in the video (only for video).

hasAlphaboolean

Specifies if the image has an alpha channel.

customMetadataCustomMetadata

A key-value data associated with the asset.

selectedFieldsSchemaSelectedFieldsSchema

This field is included in the response only if the Path policy feature is available in the plan. It contains schema definitions for the custom metadata fields selected for the specified file path. Field selection can only be done when the Path policy feature is enabled.

Keys are the names of the custom metadata fields; the value object has details about the custom metadata schema.

embeddedMetadataEmbeddedMetadata

Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data.

descriptionstring

Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension.

createdAtstring date-time

Date and time when the file was uploaded. The date and time is in ISO8601 format.

updatedAtstring date-time

Date and time when the file was last updated. The date and time is in ISO8601 format.