Get an Image File Download URL

Retrieves a pre-signed download URL of an image file.

Request URL

GET {base_url}/uc-cautop/api/v1/image-files/{id}/download

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The image file ID. You can obtain the ID using the Search Image Files interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<Download_Info> The download information of the image file.
Download_Info
Parameter Type Description
downloadUrl String The pre-signed download URL of the image file, which expires after a period of time.
fileName String The original file name of the image file.