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)
  • 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
  • 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

Text

Last updated: 2026/09/02

Parameters

txt

Overlays text on the image.
This value is required to display text.
If not set, all other text parameters will be ignored.
Example: ?txt=Hello%20World!


Example) ?txt=HELLO%20WORLD!&txt-size=62&txt-color=ffffff&txt-align=middle,center&txt-font=Futura%20Condensed%20Medium

txt-align

Sets the alignment of the text overlay within the image.
For vertical alignment, you can choose top, middle, or bottom, and for horizontal alignment, left, center, or right.
The default is bottom, right.
Example: ?txt=Hello%20World!&txt-align=middle,center

txt-clip

Cuts off text that exceeds the display area.
Specify the position to cut from start, middle, or end, and you can display "..." based on the presence of ellipsis.
The default is end.
Additionally, you can control the display area using txt-pad and txt-width.
Example: ?txt=ABCDEFGHIJKLMNOPQRSTUVWXYZ&txt-size=62&txt-color=ffffff&txt-align=middle,center&txt-clip=end,ellipsis


Example) ?txt=ABCDEFGHIJKLMNOPQRSTUVWXYZ&txt-size=62&txt-color=ffffff&txt-align=middle,center&txt-clip=middle

txt-color

You can specify the text color.
Use hexadecimal formats such as RGB, ARGB, RRGGBB, and AARRGGBB.
A represents the alpha value (transparency), while RGB represents the values for red, green, and blue, respectively.
The default is 000.
Example: ?txt=microCMS&txt-size=62&txt-color=99ffffff&txt-align=middle,center

txt-fit

Fits the text to the display area.
max is the only option that can be specified.
The default is none specified.
Example: ?txt=ABCDEFGHIJKLMNOPQRSTUVWXYZ&txt-size=62&txt-color=fff&txt-align=middle,center&txt-fit=max

txt-font

You can specify the font for the text.
You can use CSS category specifications (serif, sans-serif, monospace, cursive, fantasy) or explicit font names.
You can also specify bold and italic using a comma.
Example) ?txt=microCMS&txt-size=62&txt-color=fff&txt-align=middle,center&txt-font=Helvetica%20Neue


Example: ?txt=microCMS&txt-size=62&txt-color=fff&txt-align=middle,center&txt-font=serif,italic

txt-size

You can specify the text size.
The default value is 12.
Example: ?txt=microCMS&txt-size=24&txt-color=fff&txt-align=middle,center

txt-line

You can specify the outline width of the text.
The outline is drawn inside the text.
The default value is 0.
Example: ?txt=microCMS&txt-size=70&txt-color=0000&txt-align=middle,center&txt-line=2

txt-line-color

You can specify the outline color of the text.
Please use it in conjunction with txt-line.
Specify in hexadecimal format: RGB, ARGB, RRGGBB, AARRGGBB.
A represents the alpha value (transparency), and RGB represents the values for red, green, and blue respectively.
The default is fff.
Example: ?txt=microCMS&txt-size=70&txt-color=0000&txt-align=middle,center&txt-line=2&txt-line-color=ffc427

txt-pad

You can specify the padding around the text.
The default is 10.
Example: ?txt=microCMS&txt-pad=20


Example)?txt=ABCDEFGHIJKLMNOPQRSTUVWXYZ&txt-size=62&txt-color=ffffff&txt-align=middle,center&txt-clip=end,ellipsis&txt-pad=50

txt-shad

Adds shadow to the text.
Specify with a parameter from 0 to 10.
The default is 0.
Example) ?txt=HELLO%20WORLD!&txt-size=32&txt-color=ffffff&txt-align=middle,center&txt-shad=5

txt-width

Specifies the width of the text.
If it exceeds the text area, it will be automatically clipped.
You can adjust the clipping method using the txt-clip parameter.
The default value is automatically calculated based on the width of the image.
Example: ?txt=HELLO%20WORLD!&txt-size=32&txt-color=ffffff&txt-align=middle,center&txt-width=200

txt-x

Specifies the X-axis of the text.
Example) ?txt=HELLO%20WORLD!&txt-size=32&txt-color=ffffff&txt-x=25

txt-y

Specifies the Y-axis for the text.
Example) ?txt=HELLO%20WORLD!&txt-size=32&txt-color=ffffff&txt-y=25

Contents

  • Parameters
  • txt
  • txt-align
  • txt-clip
  • txt-color
  • txt-fit
  • txt-font
  • txt-size
  • txt-line
  • txt-line-color
  • txt-pad
  • txt-shad
  • txt-width
  • txt-x
  • txt-y
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.