Files

Get an image rendition of a file by ID

Changed on

This endpoint returns an image rendition of the specified file, suitable for display in previews, thumbnails, or alternate resolution downloads.

NOTE:

  • The file must exist and the requester must have at least read-level access.
  • If the file is not found or access is denied, appropriate error responses will be returned.
  • Image renditions of discarded files can be retrieved using this endpoint.
  • If the file exists, but the requester does not have the requisite permissions:
    • The API will behave as if the file does not exist.
    • It will return a 404 Not Found response, even though the asset technically exists in the system.
get/files/{assetId}/image-rendition

Request

  • Base URL: https://cloudstorage.adobe.io/v1
  • URL: https://cloudstorage.adobe.io/v1/files/{assetId}/image-rendition
  • Auth: HTTP bearer

Path parameters

assetIdstring required

A globally unique identifier for the asset

Example:urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174

The ID of the asset to get.

Query parameters

sizeinteger

The desired dimension of the resulting rendition on the longest side, whether that is width or height.

mediaTypestring

The desired content type of the resulting rendition.

Headers

x-request-idstring
Example:1234567890

The X-Request-Id header is used to identify a request.
It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

Response

Success - Retrieved image rendition of the file

Changes

  • 240b6278279cRevision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

  • 01600f5358e9Revision changes
    • warning

      deleted the header request parameter If-Match

    • warning

      deleted the header request parameter If-None-Match

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new operation_timeout enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status

    • warning

      added the new resource_too_large enum value to the response property for the response status