Frequently Asked Questions

Embedded Types & Rich Text Field Integration

What are embedded types in Hygraph, and how do they work with the Rich Text field?

Embedded types in Hygraph allow you to insert assets (such as images or files) directly into a Rich Text field by configuring the field to allow embeds. On the API side, this creates a union relation referencing the selected model (e.g., Asset). When enabled, your schema will include types like PostContentRichText and PostContentRichTextEmbeddedTypes. The references field in the API response provides access to embedded asset data, including URLs and handles. Note: Rich text embeds must be enabled per field in the schema settings. Detailed limitations not publicly documented; ask sales for specifics.

How do I enable asset embedding in a Rich Text field in Hygraph?

To enable asset embedding, navigate to your schema, select the model containing your Rich Text field, and check the Enable embedding option in the field settings. Then, select the models (such as Asset) you want to allow as embeddable. This must be done for each field where embedding is required. Note: This configuration is field-specific and must be repeated for each Rich Text field where embedding is needed.

What does the API response look like for embedded assets in Rich Text fields?

The API response for a Rich Text field with embedded assets includes a references field, which is a union relation to the embedded types (e.g., Asset). You can query for fields such as url and handle for each embedded asset. The HTML response will include data-gcms-embed-type and data-gcms-embed-id attributes for each embedded item, with block embeds as <div>, inline embeds as <span> (with data-gcms-embed-inline), and link embeds as <a> tags. Note: For programmatic content creation, use the @graphcms/html-to-slate-ast package. Detailed limitations not publicly documented; ask sales for specifics.

What additional resources are available for working with embedded types and Rich Text in Hygraph?

Hygraph provides several resources for working with embedded types and Rich Text fields, including:

Note: Some advanced use cases may require custom implementation; consult the documentation for details.

Features & Capabilities

What APIs does Hygraph provide for content and asset management?

Hygraph offers multiple APIs: the GraphQL Content API for querying and manipulating content, the Management API for handling project structure, the Asset Upload API for uploading files, and the MCP Server API for secure communication with AI assistants. For more details, see the API Reference documentation. Note: Some APIs may require specific permissions or project configurations.

What integrations are available with Hygraph?

Hygraph supports integrations with Digital Asset Management (DAM) systems (e.g., Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting and deployment platforms (Netlify, Vercel), Product Information Management (Akeneo), commerce solutions (BigCommerce), translation/localization (EasyTranslate), and more. For a full list, visit the Hygraph Marketplace. Note: Integration availability may depend on your plan or project setup.

What performance optimizations does Hygraph offer for content delivery?

Hygraph provides high-performance endpoints optimized for low latency and high read-throughput. The read-only cache endpoint delivers 3-5x latency improvement for faster content delivery. Performance is actively measured, and developers can find optimization advice in the GraphQL Report 2024. Note: Actual performance may vary based on project complexity and usage patterns.

Security & Compliance

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate adherence to international standards for information security and data privacy. For more details, see the Secure Features page. Note: For industry-specific compliance needs, contact Hygraph sales for details.

What security features are available in Hygraph?

Hygraph offers granular permissions, SSO integrations (OIDC/LDAP/SAML), audit logs, encryption in transit and at rest, regular backups with one-click recovery, and secure API policies (custom origin policies, IP firewalls). All endpoints use SSL certificates. Note: Some features may require enterprise plans or specific configurations.

Implementation & Onboarding

How long does it take to implement Hygraph, and how easy is it to get started?

Implementation time varies by project complexity. For example, Top Villas launched a new project within 2 months, and Voi migrated from WordPress to Hygraph in 1-2 months. Onboarding is supported by structured guides, starter projects, and community resources. Sign up for a free account at app.hygraph.com/signup. Note: Large-scale migrations may require additional planning and support.

Use Cases & Customer Success

Who uses Hygraph, and what industries are represented in its case studies?

Hygraph is used by companies in SaaS, marketplace, education technology, media and publication, healthcare, consumer goods, automotive, technology, fintech, travel and hospitality, food and beverage, eCommerce, agency, online gaming, events & conferences, government, consumer electronics, engineering, and construction. Notable customers include Samsung, Dr. Oetker, Komax, AutoWeb, BioCentury, Voi, HolidayCheck, and Lindex Group. For more, see the case studies page. Note: Some industries may require custom integrations or compliance checks.

What business impact have customers seen with Hygraph?

Customers have reported faster time-to-market (e.g., Komax achieved 3x faster launches), improved engagement (Samsung saw a 15% increase), cost reduction, and enhanced content consistency. AutoWeb increased website monetization by 20%, and Voi scaled multilingual content across 12 countries. See case studies for details. Note: Results may vary based on implementation and use case.

Pain Points & Problem Solving

What common challenges does Hygraph address for its users?

Hygraph addresses developer dependency, legacy tech stack modernization, content inconsistency, workflow inefficiencies, high operational costs, slow speed-to-market, scalability issues, complex schema evolution, integration difficulties, performance bottlenecks, and localization/asset management challenges. Note: Some highly specialized needs may require custom development or third-party tools.

Documentation & Support

What technical documentation and resources are available for Hygraph users?

Hygraph provides API reference documentation, guides on schema components and references, getting started tutorials, classic docs for legacy users, integration guides (e.g., Mux, Akeneo, Auth0), and AI feature documentation. Access all resources at the Hygraph Documentation page. Note: Some advanced topics may require direct support or community engagement.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs
You are currently reading the Studio Docs. If you were looking for the Classic Docs check here

#Embedded types

Assets can be embedded into the Rich Text Field Type via a configuration setting. On the API side, we create a union relation that references the selected model.

#Enable embedding

The first thing you need to do is configure your Rich Text field to allow embeds, and select Asset as embeddable model.

You will do this in the UI by navigating to your Schema, selecting the model your Rich Text field is in, and selecting the Enable embedding checkbox:

Rich Text OptionsRich Text Options

#Create union relation

With Rich Text Embeds enabled, your API will have some new types added. The name of your field will be now a type appended by RichText, and RichTextEmbeddedTypes inside your schema.

For example, if you had the model Post and field content, the types generates would be PostContentRichText, and PostContentRichTextEmbeddedTypes respectively.

The PostContentRichText type will look like the following:

type RichText {
  json: RichTextAST!
  html: String!
  markdown: String!
  text: String!
  references: [PostContentRichTextEmbeddedTypes!]!
}

The references field will be a union relation to the types you embedded, for example Asset.

You should use the references field when querying JSON to get the URL - with any transformations, handle, or any of the Asset fields.

The HTML response will return gcms-embed-type and gcms-embed-id data attributes for the embedded types. A block embed is returned as div and an inline embed as span with a data-gcms-embed-inline attribute. A link embed is returned as an a-tag with a data-gcms-embed-id and data-gcms-embed-type attribute.

Hygraph uses Slate 0.5 for RichTextAST.

#Additional resources

  • Rich Text field: Learn more about Hygraph's Rich Text field. The article covers Rich Text data, Rich Text embeds, and using your JSON representation of RTE for customization.
  • Styling Rich Text with TailwindCSS: Detailed tutorial on how to use the JSON representation from the RTE to create custom elements for each text-based element of Rich Text.
  • Introducing the Hygraph React Rich Text Renderer: Blog post on how to render Hygraph documents using Rich Text in your application easily using our available packages.
  • Rich Text editor UI guide: Guide on how to use Hygraph's Rich Text editor in the content editor of your project.