Contentful Images

API

API for retrieving and transforming Contentful-hosted images

Overview

The Contentful Images API allows fetching images stored in Contentful and applying dynamic transformations via URL query parameters. Supported transformations include resizing, cropping (smart, face-detection), format conversion (JPEG, PNG, WebP, AVIF), quality adjustment, rotation, and watermarking. Endpoints are asset-based, using image IDs and transformation params to generate optimized URLs. Responses are direct image files in the requested format. Use cases include optimizing images for responsive web design, generating thumbnails, converting to modern formats for faster loads, and customizing visuals dynamically in apps integrated with Contentful.

Example Integration (JavaScript)

script.js JS


fetch('https://www.contentful.com/developers/docs/references/images-api/')
  .then(res => res.json())
  .then(data => console.log(data))
  .catch(err => console.error(err));

Key Features

URL-based transformation parameters
Modern format support (WebP, AVIF)
Smart cropping & face detection
Quality optimization
Direct image file responses

Frequently Asked Questions

? Is Contentful Images free to use?

It depends on your Contentful plan. Free plans include limited transformations; paid plans offer higher limits and advanced features.

? Does it require an API Key?

Public Contentful spaces need no API key. Private spaces require authentication via Contentful credentials.

? What is the response format?

Responses are direct image files (JPEG, PNG, WebP, AVIF) instead of JSON.

Top Alternatives

Cloudinary Images API Search Google

Imgix API Search Google

Fastly Image Optimizer API Search Google

Tool Info

Pricing Freemium

Category Development

Platform Public API

Pros

⊕ Seamless Contentful asset integration
⊕ Comprehensive transformation tools
⊕ Web-optimized output
⊕ No auth for public Contentful spaces

Cons

⊖ Limited to Contentful-hosted images
⊖ Rate limits tied to Contentful plans
⊖ No non-Contentful image support