Skip to content

Each component (block) can include the following field types:

TypeLabelDescription
assetAssetA single uploaded file (image, video, audio, or document) with optional support for external URLs.
multiassetAsset (multi)Multiple uploaded files (images, videos, audio, or documents).
bloksBlocksA field for nesting other components, with configurable minimum and maximum limits.
booleanBooleanA toggle stored as true or false.
datetimeDate/timeA picker for ISO 8601 date values with optional time selection.
sectionGroupA widget that visually groups other fields in the editor without affecting the API response.
multilinkLinkA link input for stories, URLs, assets, or email addresses.
markdownMarkdownA text input stored as Markdown with a customizable toolbar.
numberNumberA numeric input with configurable minimum, maximum, decimals, and step.
optionOptionA single-select dropdown sourced from a list, stories, a datasource, or an external API.
optionsOption (multi)A multi-select dropdown sourced from a list, stories, a datasource, or an external API. Set is_reference_type: true to use it as a References field.
customPluginA custom field type. Refer to Introduction to Field Plugins to learn more.
richtextRich textA formatted text input stored as JSON, based on the TipTap editor.
tableTableA table editor with flexible columns and rows.
textTextA short text input with character limits and regex validation.
textareaTextareaA multi-line text input without formatting.
imageImage (deprecated)A legacy upload field for a single image with cropping options.
fileFile (deprecated)A legacy upload field for a single file.
Example object
{
"component": {
"name": "hero_section",
"display_name": "Hero Section",
"schema": {
"title": {
"type": "text",
"display_name": "Title",
"required": true
},
"subtitle": {
"type": "textarea",
"display_name": "Subtitle"
}
}
}
}

Was this page helpful?

What went wrong?

This site uses reCAPTCHA and Google's Privacy Policy (opens in a new window) . Terms of Service (opens in a new window) apply.