Cloudinary API
Cloudinary DocsGet API keys
HomeAPI ReferenceSDKsContext Plugin
Assets

Get the details of a single asset by body parameters

POST
/v1_1/{cloud_name}/resources/get_resource

Returns the details of a single asset identified by its public ID, delivery type, and resource type passed in the request body.

Authorization

AuthorizationBasic <token>

Basic authentication using Cloudinary API Key and API Secret.

In: header

Path Parameters

cloud_name*string

The cloud name of your product environment.

Request Body

application/json

The identifying attributes of the asset to retrieve.

The identifying attributes of the asset to retrieve.

public_id*string

The public ID of the asset to retrieve.

resource_type*string

The type of the asset (image, video, or raw).

Value in

  • "image"
  • "video"
  • "raw"
kind*string

The delivery type of the asset.

Value in

  • "upload"
  • "private"
  • "authenticated"
with_elastic?boolean

Whether to source the asset details from the search index. If false, the details are read directly from the canonical store. Default is true.

derived?boolean

Whether to include the derived assets of this asset in the response. Default is true.

versions?boolean

Whether to include the backup versions of this asset in the response. Default is false.

[key: string]?any

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1_1/my_cloud/resources/get_resource" \  -H "Content-Type: application/json" \  -d '{    "public_id": "string",    "resource_type": "image",    "kind": "upload"  }'
{  "asset_id": "string",  "public_id": "string",  "asset_folder": "string",  "display_name": "string",  "folder": "string",  "filename": "string",  "format": "string",  "version": 0,  "resource_type": "string",  "type": "upload",  "created_at": "2019-08-24T14:15:22Z",  "uploaded_at": "2019-08-24T14:15:22Z",  "bytes": 0,  "backup_bytes": 0,  "width": 0,  "height": 0,  "aspect_ratio": 0,  "pixels": 0,  "tags": [    "string"  ],  "context": {    "custom": {      "property1": "string",      "property2": "string"    },    "property1": {      "property1": "string",      "property2": "string"    },    "property2": {      "property1": "string",      "property2": "string"    }  },  "metadata": {},  "moderation_kind": "string",  "moderation_status": "string",  "moderation": [    {      "kind": "string",      "status": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "backup": true,  "url": "http://example.com",  "secure_url": "http://example.com",  "status": "string",  "access_control": [    {      "access_type": "token",      "key": "string",      "start": "string",      "end": "string"    }  ],  "etag": "string",  "animated": true,  "duration": 0,  "resource_subtype": "string",  "substatus": "string",  "related_assets": [    {}  ],  "last_updated": {    "access_control_updated_at": "2019-08-24T14:15:22Z",    "context_updated_at": "2019-08-24T14:15:22Z",    "metadata_updated_at": "2019-08-24T14:15:22Z",    "public_id_updated_at": "2019-08-24T14:15:22Z",    "tags_updated_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "next_cursor": "string",  "derived": [    {      "transformation": "string",      "format": "string",      "bytes": 0,      "id": "string",      "url": "http://example.com",      "secure_url": "http://example.com"    }  ],  "faces": [    [      0    ]  ],  "coordinates": {    "faces": [      [        0      ]    ],    "custom": [      [        0      ]    ]  },  "illustration_score": 0,  "semi_transparent": true,  "grayscale": true,  "colors": [    []  ],  "predominant": {    "property1": [      []    ],    "property2": [      []    ]  },  "versions": [    {      "version_id": "string",      "version": "string",      "format": "string",      "size": 0,      "time": "2019-08-24T14:15:22Z",      "restorable": true    }  ],  "info": {},  "derivatives": [    {      "id": "string",      "transformation": "string",      "transformation_signature": "string",      "secure_url": "http://example.com"    }  ]}

Invalidate derived assets by delivery URLs DELETE

Deletes and invalidates the cached derived assets that back the specified delivery URLs.

Update the details of a single asset by body parameters POST

Updates the details of an existing asset (such as tags, contextual metadata, structured metadata, and moderation status) identified by its public ID, delivery type, and resource type passed in the request body.