Skip to content

👀 See Sanity in action: Watch product demo now →

Sanity Studio - Flexible editing environment
Content Lake - Real-time database
Developer experience - Tooling you love
Structured content - The philosophy behind Sanity
Review changes - View edits & rollback instantly
Image pipeline - On-demand transformations

E-commerce - Better shopping experiences
Marketing sites - Control your story
Products & services - Innovate and automate
Mobile apps - Content backend for every OS
Aether - Unique digital shopping experience
Morning Brew - Omnichannel media distribution
InVision - Delivering exceptional customer experiences
DataStax - Personalization for global audience
React
Gatsby
Next
Nuxt
Eleventy
Netlify
Vercel
Algolia

Documentation
Reference
Guides
Resource library
Headless CMS
Tools & plugins
Project showcase
Schemas & snippets
Agency partners
Technology partners
Get support
Share your work
Enterprise SSO

Enterprise Pricing

Contact sales Log in Get started

Overview
Getting started
Sanity Studio
Content Lake
Build with Sanity
- Convince your team
- Convince your clients
- Pro Bono Plans
- Open-source projects
- Non-profit organizations
Access control
Reference
- SANITY STUDIO
- NEWConfiguration API
- NEWSchema
  - SCHEMA TYPES
  - Array
  - Block
  - Boolean
  - Cross Dataset Reference
  - Date
  - Datetime
  - Document
  - File
  - Geopoint
  - Image
  - Number
  - Object
  - Reference
  - Slug
  - String
  - Span
  - Text
  - URL
  - MISC
  - Initial Value Templates API
- NEWPlugins
- NEWTools
- NEWForm
  - Components
  - Asset Source
- NEWStudio Components
- NEWDocument
  - Document Actions API
  - Document Badges API
- NEWHistory experience
- NEWDesk Tool
- NEWTheme
- NEWAuthentication
  - OAuth2
- NEWStructure Builder
- NEWStudio React Hooks
- NEWCommand line interface
- CONTENT LAKE
- HTTP API
  - URL format
  - Authentication
  - Patches
  - Using JSONMatch
  - Endpoints
  - Scheduling API
  - Assets
  - Doc
  - Export
  - History
  - Listen
  - Mutate
  - Projects
  - Roles
  - Jobs
  - Query
- Query language (GROQ)
- Image transformations
  - Image Metadata
  - IIIF API reference
- Integration
- Client libraries
- Portable Text
- Project Management
- Projects, organizations, and billing
- Plans and Payments
Studio v2 docs

Component API Reference

About the Component API

Updated on December 7, 2022

Was this article helpful?

Platform

Structured Content Developer experience Content Lake Sanity Studio Security & Compliance

Sanity vs Contentful
Sanity vs Strapi
Sanity vs Adobe Experience Manager
Sanity vs Hygraph
Sanity vs Sitecore
Sanity vs Storyblok
Sanity vs Contentstack
Sanity vs Prismic
Sanity vs Drupal

Resources

React Blog
Gatsby Blog
Next.js Landing Pages
Progressive Web Application
Single Page Application
Svelte & Typescript App
Vue & Tailwind Blog
Developer Portfolio Templates
Form validation with Yup
Live Preview with Next.js and Sanity.io

Resource library

Agency partners
Technology partners

Blog Template
Personal Website Template
Developer Portfolio Templates
All Templates

Headless CMS
What is an API CMS
Static Sites 101
Headless SEO
Localization
GraphQL vs REST
What is a DXP?
Typescript 101

React CMS
Next.JS CMS
CMS for Shopify
Content platform
Multilingual CMS
Static Site CMS
Gatsby CMS
Node CMS
E-commerce CMS
Vue CMS
Angular CMS
GraphQL CMS
Newspaper CMS
Magazine CMS
Mobile apps CMS

Company

Contact Sales Enterprise Careers Terms of Service Accessibility Statement

Stay connected

GitHub
Slack
Twitter
YouTube
Stack Overflow
Blog RSS
Newsletter

©Sanity 2023

Set appearance to light mode