Frequently Asked Questions

Content Models & Schema

What is a model in Hygraph and how does it define my schema?

In Hygraph, a model is a core building block of your schema. Each model represents a content type (such as Post) and is defined by the fields you add. Models allow you to structure your content, create relationships, and manage data efficiently. All changes to your schema are immediately available via GraphQL. Note: Models must be carefully managed, as deleting a model will also delete all associated content entries. Learn more.

How do I create a model in Hygraph and what settings are available?

To create a model, use the schema builder in Hygraph. Each model has settings such as Display Name, API ID, Plural API ID, and Description. Hygraph automatically scaffolds default values for API ID and Plural API ID based on the Display Name, and these are available via the API in camel case. For example, a model named Post will have API IDs post and posts. Note: The Description field is optional and serves as a hint for content editors. See documentation.

What queries and mutations are automatically generated for a model?

When you create a model in Hygraph, the API automatically generates queries and mutations for that model. For example, a Post model will have: post, posts, postVersion, postsConnection, createPost, updatePost, deletePost, upsertPost, publishPost, unpublishPost, and batch operations like updateManyPostsConnection. This enables programmatic content management. Note: Custom input types are also generated. See queries and mutations.

How can I edit or delete a model in Hygraph?

You can update the settings and preview URLs for your content models at any time using the schema builder. To delete a model, select it in the schema builder and choose the delete option. Deleting a model will also delete all content entries associated with it. Note: This action is irreversible and should be performed with caution. Edit models | Delete models.

How do I add fields to a model in Hygraph?

Fields can be added to all custom models and the system Asset model by selecting the desired field type from the fields list when viewing a model. This allows you to customize your schema to fit your content needs. Note: System fields such as ID, created, and updated timestamps are managed automatically by Hygraph and do not need to be added manually. See field types.

What are system fields in Hygraph models?

All models in Hygraph include system fields such as ID, created, and updated timestamps. These fields are managed automatically and do not need to be added manually. They help track content changes and ensure data integrity. Learn more about system fields.

How do preview URLs work for models in Hygraph?

Preview URLs allow you to generate links for content previews based on model fields, such as a slug. For example, a Post model might have preview URLs like https://hygraph.com/blog/{slug} for production or https://staging.hygraph.com/blog/{slug} for staging. These URLs help you test and review content before publishing. Note: Preview URLs are most useful for models representing pages. See preview URL docs.

Can models be embedded in rich text fields?

Yes, all models can be embedded into the Rich Text Field Type via a configuration setting. On the API side, Hygraph creates a union relation that references the selected model, enabling flexible content structures. Note: Embedding models increases schema complexity and should be planned carefully. See rich text field docs.

API & Technical Documentation

What APIs does Hygraph provide for managing models and content?

Hygraph offers several 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 AI assistant communication. Each API is documented in detail in the API Reference documentation. Note: Some APIs require specific permissions or SDKs. See API docs.

Where can I find technical documentation for working with models in Hygraph?

Technical documentation for models, fields, permissions, caching, and webhooks is available in the API Reference documentation. For schema components and references, see the Components Documentation and References Documentation. Note: Classic Docs are available for legacy projects. See Classic Docs.

Features & Capabilities

What are the key features of Hygraph that support content modeling?

Hygraph supports content modeling with features like a GraphQL-native architecture, automatic API generation for models, content federation, user-friendly schema builder, and support for embedded types and preview URLs. These features enable flexible, scalable, and efficient content management. Note: Advanced features such as content federation and Smart Edge Cache are available for enterprise use cases. See feature overview.

What integrations are available for extending model functionality in Hygraph?

Hygraph offers integrations with Digital Asset Management (DAM) systems (e.g., Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting platforms (Netlify, Vercel), Product Information Management (Akeneo), commerce solutions (BigCommerce), and translation/localization tools (EasyTranslate). For a full list, visit the Hygraph Marketplace. Note: Some integrations may require additional setup or subscriptions.

Security & Compliance

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (achieved August 3, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications ensure high standards for information security and data protection. Note: For more details, visit the Secure Features page.

What security features are available for managing models and content in Hygraph?

Hygraph provides 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 have SSL certificates. Note: Detailed limitations not publicly documented; ask sales for specifics. See security features.

Performance & Implementation

How does Hygraph perform for content delivery and API usage?

Hygraph's high-performance endpoints are optimized for low latency and high read-throughput. The read-only cache endpoint delivers 3-5x latency improvement. 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 integration choices. See performance blog.

How long does it take to implement Hygraph for a new project?

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. Starter projects, onboarding guides, and community support help accelerate adoption. Note: Large-scale migrations may require additional planning. See Getting Started guide.

Use Cases & Customer Success

Who can benefit from using Hygraph models and schema features?

Developers, content creators, product managers, and marketing professionals in enterprises, SaaS, eCommerce, media, healthcare, automotive, and more can benefit from Hygraph's modeling and schema features. The platform supports both technical and non-technical users, enabling efficient content management and delivery. Note: Teams with highly specialized legacy systems may require additional integration work. See case studies.

What business impact have customers seen from using Hygraph?

Customers have reported faster time-to-market (Komax achieved 3x faster launches), improved engagement (Samsung saw a 15% increase), and cost reduction (AutoWeb increased monetization by 20%). These outcomes are documented in public case studies. Note: Results may vary by use case and implementation. See customer stories.

Limitations & Considerations

What are the limitations when deleting a model in Hygraph?

Deleting a model in Hygraph will also delete all content entries associated with that model. This action is irreversible and should be performed with caution. Note: Always back up your data before deleting models. See delete model docs.

LLM optimization

When was this page last updated?

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

Hygraph
Docs

#Models

Your schema is defined by the models you create, and fields you add. Inside the schema builder, you can add fields, create relationships between models, and much more.

#Create a model

All models have the following settings:

PropertyExampleDescription
Display namePostThe name displayed inside Hygraph, and content editors.
API IDPostThe name for fetching a single entry
Plural API IDPostsThe name for fetching multiple entries
DescriptionBlog postsOptional hint for content editors when interacting with fields.

Hygraph will automatically scaffold default values for API ID, and Plural API ID based on the Display name. These values will be available via the API as camel case.


For example, let's imagine we have the model Post. The following queries, and mutations would be generated by the API automatically, as well as custom input types:

  • post
  • posts
  • postVersion
  • postsConnection
  • createPost
  • updatePost
  • deletePost
  • upsertPost
  • publishPost
  • unpublishPost
  • updateManyPostsConnection
  • deleteManyPostsConnection
  • publishManyPostsConnection
  • unpublishManyPostsConnection

Learn more about queries, and mutations.

#Edit a model

You can at any time update the settings, and Preview URLs for your content models from within the schema builder.

#Delete a model

For each of the content models you have created, you can choose to update, or delete from the schema builder.

Deleting a model will also delete all of the content entries.

#Adding fields

You can add fields to all custom models, and the system Asset model by selecting the field type from the fields list when viewing a model.

#System fields

All models have system fields. You don't need to add an ID, created, or updated timestamp. These are managed by Hygraph automatically.

Learn more about system fields.

#Preview URLs

It's most common to create a preview URL for models that represent a page, and have a field such as a slug.

The fields on your model are available to use within the URL template. For example, a Post model may have the following preview URLs:

Preview nameURL template
Productionhttps://hygraph.com/blog/{slug}
Staginghttps://staging.hygraph.com/blog/{slug}
Next.js Previewhttps://hygraph.com/api/preview?secret=abc&slug={slug}

#Embedded types

All models 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.