Explode

Create derived images from multi-page file

POST
/v1_1/{cloud_name}/{resource_type}/explode

Generates derived images for each of the individual pages/frames in a multi-page/frame file (such as a PDF or animated image).

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.

resource_type*"image"

The type of resource to explode. Only "image" is supported.

Value in

  • "image"

Request Body

application/json

The explode operation parameters.

api_key?string

The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.

timestamp?integer

The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.

Formatint64
signature?string

(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.

public_id*string

The public ID of the PDF or animated image to generate from.

format?string

The format for the generated derived images. Default: png

transformation*string

The transformation to apply. Must contain exactly one pg_all transformation parameter.

notification_url?string

The webhook URL to notify when the operation is complete.

Formaturi
type?managed_delivery_type

The delivery type of the asset. Default: upload

Value in

  • "upload"
  • "private"
  • "authenticated"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1_1/my_cloud/image/explode" \  -H "Content-Type: application/json" \  -d '{    "public_id": "string",    "transformation": "string"  }'
{  "status": "processing",  "batch_id": "string"}