Cloudflare Docs
Cloudflare Image Optimization
Cloudflare Docs
Cloudflare Image Optimization
GitHub icon
Visit Cloudflare Image Optimization on GitHub
Set theme to dark (⇧+D)
  1. Products
  2. Cloudflare Image Optimization
  3. Cloudflare Images
  4. Make your first API request

Make your first API request

To make your first request to the Images API, you must obtain these pieces of information:

Your Cloudflare Account ID
  1. Log in to the Cloudflare dashboard, and select your account and website.
  2. In Overview, scroll down to find your Account ID.
Your Global API Key or API Token

To use Cloudflare Images you need to create a custom token with the correct Read and Update permissions:

  1. In the Cloudflare dashboard, locate API Tokens under My Profile > API Tokens.
  2. Select Create Token.
  3. In Custom token, select Get started.
  4. Give your custom token a name.
  5. Scroll to Permissions.
  6. On the Select item… drop-down menu, choose Cloudflare Images.
  7. In the next drop-down menu, choose Edit.

How to create a custom token for Cloudflare images

  1. Select Continue to summary > Create Token.

Your token for Cloudflare Images is now created. Copy it and keep it in a safe place. It grants access to your Cloudflare Images account.

Refer to Creating API tokens for more details about API tokens.

Once you have this information, you are ready to upload your first image to Cloudflare Images using the API. In the following example, the -F flag is used to upload images from your local computer:

curl -X POST \
  "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/images/v1" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -F file=@./<YOUR_IMAGE.IMG>

Refer to Upload images for a complete overview of the different options to upload images with the API.

After uploading your images, a successful response will look similar to this:

{
  "result": {
    "id": "<IMAGE_ID>",
    "filename": "<IMAGE.IMG>",
    "uploaded": "2021-09-14T05:52:14.767Z",
    "requireSignedURLs": false,
    "variants": [
      "https://imagedelivery.net/<ACCOUNT_HASH>/<IMAGE_ID>/<VARIANT_NAME>"
    ]
  },
  "result_info": null,
  "success": true,
  "errors": [],
  "messages": []

}

The response has details regarding the image you uploaded, such as its ID as well as the default public variant URL. In the above example, the public variant would show as https://imagedelivery.net/<ACCOUNT_HASH>/<IMAGE_ID>/public.

After you set up other variants in your account, the "variants" property in the response will show the URLs for them:

{
  "result": {
    "id": "<IMAGE_ID>",
    "filename": "<IMAGE.IMG>",
    "uploaded": "2021-09-14T05:52:14.767Z",
    "requireSignedURLs": false,
    "variants": [
      "https://imagedelivery.net/<ACCOUNT_HASH>/<IMAGE_ID>/public",
      "https://imagedelivery.net/<ACCOUNT_HASH>/<IMAGE_ID>/<VARIANT_NAME_1>",
      "https://imagedelivery.net/<ACCOUNT_HASH>/<IMAGE_ID>/<VARIANT_NAME_2>"
    ]
  },
  "result_info": null,
  "success": true,
  "errors": [],
  "messages": []

}

You can use the URLs in the "variants" property of the response to serve images from your Cloudflare Images account.