microCMS
Documentation
  • Pricing
  • Blog
  • FAQ
  • Contact
  • Sign In
  • Get started for free
Navigation
Tutorial
Next.js
  • Integration with Next.js
  • Getting Started with App Router
  • Tutorial (App Router)
  • Getting Started with Pages Router
  • Tutorial (Pages Router)
Astro
  • Getting Started
  • Integration with Astro
  • Tutorial
Nuxt
  • Integration with Nuxt
  • Getting Started
  • Tutorial
Gatsby
  • Integration with Gatsby
  • Getting Started
  • Tutorial
JavaScript
  • Integration with JavaScript
  • Getting Started (Browser)
  • Getting Started (Server)
PHP
  • Integration with PHP
  • Getting Started
Ruby
  • Integration with Ruby
  • Getting Started
Go
  • Integration with Go
  • Getting Started with microCMS
Manual
  • Introduction
Account & Login
  • Account Registration
  • Login
  • Email Address Authentication
Services
  • Creating a Service
  • Service Configuration
  • Template
  • Service Deletion
Payment
  • Change of Pricing Plan
  • Registering and Changing Payment Methods
API
  • Creating and Managing APIs
  • API Settings
  • Export/Import of API Schema
Fields
  • Text Field
  • Text Area
  • Image
  • Multiple Images
  • Date
  • Boolean
  • Selectable Field
  • Content Reference
  • Multiple Content References
  • Number
  • File
  • Extended Field
  • Repetition
  • Custom
Contents
  • CSV Export of Content
  • Content Creation
  • Content Editing
  • Content Management
  • View
  • Content Status
  • Custom Status
  • Setting the Content ID
  • Automatically Assigned Values for Content
  • CSV Import of Content
  • API Preview
  • Examples of Using Query Parameters with API Preview
  • Integration Methods by Rendering Type
  • Screen Preview
  • Setting Up Webhooks for Content
Rich Editor
  • How to Use the Rich Editor
  • Rich Editor WRITE API
  • How to Use the Old Rich Editor
Reviews
  • Review
  • AI Review
Media
  • Media Management
  • Changing Media Filters and Display Order
  • Media Tag Configuration
  • Setting Up Media Webhooks
  • Custom Domain Settings for Media
Permission Management
  • Member Management
  • Roles (Permission Management in the Admin Panel)
Environments
  • Multiple Environments (Development Environment)
  • Merging API Settings Between Environments
Connection
  • Amazon S3 Integration
Logs
  • Audit Log
  • Data Transfer Volume
Security
  • Content Update History
  • IP Restrictions for Management Dashboard
  • IP Restrictions for APIs
Authentication
  • Setting Up Two-Factor Authentication
  • Mandatory Two-Factor Authentication
  • Single Sign-On
Specifications & Limitations
  • Recommended Environment
  • Limitations / Precautions
Content API
  • What is the Content API?
Basic Operations
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
API Keys
  • API Key (API Authentication and Authorization Management)
  • Migration from the Old API (X-API-KEY, etc.)
Responses & Error Handling
  • Response format for each field in the GET API
  • Specifying Query Parameters in the GET API
  • Error Responses of the Content API
Management API (Beta)
  • POST /api/v1/roles
  • DELETE /api/v1/roles/{role_id}
  • GET /api/v1/roles/{role_id}
  • PATCH /api/v1/roles/{role_id}
  • GET /api/v1/roles
  • What is the Management API?
Content Operations
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
Media Operations
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
Member Operations
  • PATCH /api/v1/members/{member_id}
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API Operations
  • POST /api/v1/apis
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
Service Operations
  • GET /api/v1/service
Responses & Error Handling
  • Management API Error Responses
Image API
  • What is the Image API?
Parameters
  • Image Size
  • Quality
  • Resolution and Screen Size
  • Format
  • Text
  • Border
  • Padding
  • Shape
  • Download
  • Watermark
MCP Server
  • microCMS MCP
  • microCMS Document MCP Server
  • Top
  • Image API

What is the Image API?

Last updated: 2026/11/19

microCMS has a feature called the Image API that allows you to edit images.

Even if you don't edit during the upload, you can perform various edits by adding parameters to the image URL after uploading.

For image processing, we utilize imgix's Rendering API.
In addition to the parameters listed in this document, there are other available parameters.
For more details about the API, please refer to the official imgix reference.

Information
  • ?auto=format is not supported. Thank you for your understanding.
  • The Image API is unavailable when Amazon S3 Integration is enabled.

Available Main Image Formats

  • JPEG
  • PNG
  • GIF
  • WebP
  • HEIC/HEIF

For other available formats, please refer to the Supported as input format below.

A Developer’s Guide to Understanding Image Types | Best Practices | Getting Started
https://docs.imgix.com/best-practices/guide-to-image-types#which-image-formats-can-be-served-with-imgix
Information

The Image API is not available for SVG files.

How to Apply the Image API

The Image API is applied by appending parameters to the end of the URL when displaying images retrieved from microCMS on the frontend.

How to Apply to Image Fields and Multiple Image Fields

When you register images in an image field or multiple image field, a response containing the image URLs is returned.

// Image Field
"image": {
        "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image.png",
        "height": 630,
        "width": 1200
}

// Multiple Image Field
"imageList": [
        {
                "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image1.png",
                "height": 630,
                "width": 1200
        },
        {
                "url": "https://images.microcms-assets.io/assets/xxxx/yyyy/image2.png",
                "height": 630,
                "width": 1200
        }
]

You can apply the Image API by adding parameters to the end of this URL. Below is an implementation example.

Implementation Example for Applying to Image Field

export default async function Page() {

    // Fetch data for the image field
    const { image } = await client.getListDetail({
        endpoint: 'post',
        contentId: 'contentId',
    })

    // Add parameters to the URL of the retrieved image
    const optimizedImage = `${image.url}?w=600`

    return 
}

Implementation Example for Applying to Multiple Image Field

export default async function Page() {

    // Fetch data for the multiple image field
    const { images } = await client.getListDetail({
        endpoint: 'post',
        contentId: 'contentId',
    })

    // Add parameters to the URL of each image registered in the multiple image field
    const optimizedImages = images.map(image => `${image.url}?w=600`)

    return (
        

{optimizedImages.map((url, index) => ( ))}

) }

How to Apply to Images in the Rich Text Editor

The response for data registered in the Rich Text Editor is in HTML format, so you need to extract the image URL parts to apply the Image API.
Please refer to the help article "How to Apply the Image API to Images in the Rich Text Editor" for the application method.

Information

Only the w and h parameters can be specified for each image in the Rich Text Editor. For instructions, see “How to Use the Rich Text Editor.”

Main Parameters

The main parameters that can be used with the Image API are as follows. By combining these parameters, you can flexibly adjust the format, size, and quality of the images.

Image Size
https://document.microcms.io/en/image-api/size
Quality
https://document.microcms.io/en/image-api/quality
Resolution and Screen Size
https://document.microcms.io/en/image-api/dpr
Format
https://document.microcms.io/en/image-api/format
Text
https://document.microcms.io/en/image-api/text
Border
https://document.microcms.io/en/image-api/border

Contents

  • Available Main Image Formats
  • How to Apply the Image API
  • How to Apply to Image Fields and Multiple Image Fields
  • How to Apply to Images in the Rich Text Editor
  • Main Parameters
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.