Frequently Asked Questions

Nuxt + Hygraph Implementation

How do I set up a new Nuxt project to work with Hygraph?

To set up a new Nuxt project with Hygraph, initialize your project using npx nuxi@latest init my-nuxt-project, choose your preferred package manager (npm, pnpm, yarn, or bun), and install dependencies. Start your app with npm run dev to access it at http://localhost:3000/. Note: You must configure Hygraph Content API permissions and connect the high-performance read-only endpoint for data access. Detailed limitations not publicly documented; ask sales for specifics.

How do I configure Hygraph as an image provider in Nuxt?

To use Hygraph as an image provider with the Nuxt image module, add the following to your nuxt.config.ts file: image: { providers: { hygraph: { baseURL: \"https://media.graphassets.com\" } } }. This enables Nuxt to fetch and optimize images from Hygraph's CDN. Note: If your images do not display, verify the baseURL and permissions. Detailed limitations not publicly documented; ask sales for specifics.

How do I connect my Nuxt app to Hygraph's Content API?

First, configure Content API access permissions in your Hygraph project by navigating to Project settings > Access > API Access > Content API and initializing defaults. Then, copy the High Performance Read-only Content API endpoint and use it in your Nuxt app's environment variables (e.g., GQL_HOST=https://<HYGRAPH_CDN_LOCATION>.cdn.hygraph.com/content/<ID>/master). Note: Unauthenticated requests require correct permissions; missing or incorrect permissions will block data access. Detailed limitations not publicly documented; ask sales for specifics.

What is the recommended way to add GraphQL queries in a Nuxt + Hygraph project?

Create a queries folder in your Nuxt project and add GraphQL queries as .gql files (e.g., pages.gql for all pages, page.gql for single page by slug). The nuxt-graphql-client module will automatically generate types and helper functions for these queries. Note: For large schemas or complex queries, review the module's documentation for advanced usage. Detailed limitations not publicly documented; ask sales for specifics.

How do I create dynamic page routes in Nuxt using Hygraph data?

Create a page directory inside your pages directory and add a [slug].vue file. Use the GqlPage function to fetch content by slug and render it dynamically. This allows you to generate routes for each content entry in Hygraph. Note: If slugs are not unique or missing, routing may fail. Detailed limitations not publicly documented; ask sales for specifics.

Features & Capabilities

What APIs does Hygraph provide for integration with Nuxt?

Hygraph offers several APIs: the GraphQL Content API for querying and manipulating content, the Management API for project structure, the Asset Upload API for file uploads, and the MCP Server API for AI assistant integration. For Nuxt projects, the GraphQL Content API is most commonly used. Note: Some APIs may require authentication or specific permissions. Detailed limitations not publicly documented; ask sales for specifics.

What integrations are available for Hygraph?

Hygraph supports integrations with Digital Asset Management systems (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 configuration or subscriptions. Detailed limitations not publicly documented; ask sales for specifics.

What technical documentation is available for Hygraph and Nuxt integration?

Hygraph provides comprehensive technical documentation, including API references, schema guides, integration tutorials (e.g., Mux, Akeneo, Auth0), and getting started guides. For Nuxt-specific implementation, refer to the official guide and the starter projects. Note: Documentation for advanced or edge-case scenarios may require direct support. Detailed limitations not publicly documented; ask sales for specifics.

Performance & Security

How does Hygraph ensure high performance for Nuxt applications?

Hygraph offers high-performance endpoints optimized for low latency and high read-throughput, a read-only cache endpoint with 3-5x latency improvement, and active GraphQL API performance measurement. These features help deliver content efficiently to Nuxt applications. Note: Actual performance may vary based on project complexity and network conditions. Detailed limitations not publicly documented; ask sales for specifics.

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate adherence to international standards for information security and data protection. Note: For industry-specific compliance requirements, consult Hygraph's Secure Features page or contact support. Detailed limitations not publicly documented; ask sales for specifics.

Use Cases & Success Stories

What are some real-world examples of companies using Hygraph?

Notable companies using Hygraph include Samsung (improved customer engagement by 15%), Komax (3x faster time-to-market), AutoWeb (20% increase in website monetization), and Voi (scaled multilingual content across 12 countries). For more, see the Hygraph case studies page. Note: Results may vary based on implementation and business context. Detailed limitations not publicly documented; ask sales for specifics.

What industries are represented in Hygraph's case studies?

Hygraph's case studies cover 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. Note: Some industries may have more extensive documentation than others. Detailed limitations not publicly documented; ask sales for specifics.

Support & Implementation

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

Implementation timelines vary 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 and structured onboarding can accelerate adoption. Note: Large-scale or highly customized projects may require more time. Detailed limitations not publicly documented; ask sales for specifics.

What support and onboarding resources are available for Hygraph users?

Hygraph provides structured onboarding (introduction calls, account provisioning, technical kickoffs), extensive documentation, starter projects, community Slack, webinars, and live training. Access resources at Hygraph Documentation and Hygraph Slack. Note: Some resources may require registration or a paid plan. Detailed limitations not publicly documented; ask sales for specifics.

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

#Nuxt + Hygraph

#Overview

Nuxt is a free, open-source Vue framework. You can use it to create type-safe, performant and production-grade full-stack web applications and websites intuitively.

#Creating a new Nuxt app

To start, we need to initialize a new Nuxt project. Open up your terminal, navigate to where you want your project, and run the following command:

npx nuxi@latest init my-nuxt-project

The interactive setup will ask you questions to configure your project. Initialize with the following answers:

  • Current nuxt version, Ok to proceed: Yes (y)
  • Choose package manager: npm, pnpm, yarn, or bun (the guide will use yarn)
  • Anonymous usage data collection: Yes or No
  • Initial git repository: Yes or No

Change directory into your new project from your terminal:

cd my-nuxt-project

The interactive setup should install dependencies automatically using the package manager - yarn, pnpm, npm - of your choosing, but you can use the install command if needed:

npm install

Start your Nuxt app in development mode:

npm run dev

Your new Nuxt app is now available in the browser at http://localhost:3000/

NuxtNuxt

#Configure Hygraph assets to work with Nuxt

To work with Nuxt image module, we need to specify Hygraph as an image provider by adding the base URL in the nuxt.config.ts file.

Your config file should contain the following code:

// nuxt.config.ts
export default defineNuxtConfig({
... other configuration parameters here
image: {
providers: {
hygraph: {
baseurl: "https://media.graphassets.com"
}
}
}
})

In the above config, we are using Hygraph as our image source.

#Getting data from Hygraph

Now that you have created your Nuxt project, it's time to add some data from Hygraph. Start by cloning our demo Hygraph project:

Click here to clone the demo project

After cloning, you will have a simple project that contains one content model called Page that contains fields for Title, Slug, and Body; and one content entry.

If you navigate to the Schema builder and click on the Page model, you will see this:

Demo project - Page modelDemo project - Page model

And if you navigate to the Content editor and view the sample entry details, you'll see this:

Demo project - Sample content entryDemo project - Sample content entry

#Content API

Before you can connect Nuxt to Hygraph, you will need to configure Content API access permissions for unauthenticated requests.

To do this, we'll to go Project settings > Access > API Access > Content API in our Hygraph project, scroll to find the Manage Content API access permissions box and click Initialize defaults:

Content API permissionsContent API permissions

Finally, we will copy the High Performance Read-only Content API endpoint from Project settings > Access > API Access > Endpoints. You will use it to connect Nuxt to Hygraph later on.

#Testing a query in the API playground

Next, you should test if you can fetch the information in the sample content entry that we showed you earlier. To do this, navigate to the API Playground in your project and use the following query:

If you execute the query, the response should fetch the sample query in the demo project you cloned.

#Generating Hygraph content with Nuxt

After enabling API access, you can start using the Pages query with your Nuxt app to render content.

#Adding Tailwind CSS to Nuxt

Use the terminal to go back to your Nuxt app, and type the following command:

npm install @nuxtjs/tailwindcss

This will install Tailwind CSS, so you have a few base styles to use with your content.

#Installing Nuxt GraphQL Client

The next step is to add the nuxt-graphql-client module.

This helps with codegen for GraphQL functionality and types, and provides an easy way to use GraphQL API's in Nuxt.

To install the client, type the following command:

npm install nuxt-graphql-client

After the installation finishes, add the following to your nuxt.config.ts file:

// nuxt.config.ts
export default defineNuxtConfig({
devtools: { enabled: true },
modules: ['@nuxtjs/tailwindcss','nuxt-graphql-client']
})

The nuxt-graphql-client module offers some convenient helpers for typing and querying.

Add the following to your .env file so the module knows how to connect to Hygraph for the introspection of the schema to make types, and to be able to query.

GQL_HOST=https://<HYGRAPH_CDN_LOCATION>.cdn.hygraph.com/content/<ID>/master

Want to see Nuxt and Hygraph in action? Watch a quick video on how to connect Nuxt and Hygraph:

#Adding GraphQL queries

Now that you have all the packages installed, create a queries folder and add your GraphQL queries in there as files with a .gql extension:

Query all pages - file location & name: ./queries/pages.gql

# File name: pages.gql
# File location ./queries/pages.gql
query Pages {
pages {
title
slug
body {
text
}
}
}

Query single page by slug - file location & name: ./queries/page.gql

# File name: page.gql
# File location: ./queries/page.gql
query Page($slug: String!) {
page(where: { slug: $slug }) {
title
body {
text
}
}
}

The nuxt-graphql-client module finds this folder and automatically creates types and convenience functions for all queries it finds.

#Getting a list of pages for the homepage

After adding your .env file, go to your index.vue file in the pages directory and add the following code:

HomepageHomepage

#Creating dynamic page routes with Nuxt

Now, that we have a list of pages in our homepage, we need to create a dynamic route for each page. To do this, create a new directory in the pages directory called page and a file called [slug].vue inside this directory.

Add the following code:

#Code overview

The template section of our Vue component contains the markup that renders our content on the homepage.

In the script section, we use the GqlPage() function to ask Hygraph with our Page query to fetch the title, slug, and body.

Dynamic pageDynamic page

Congratulations! You have a homepage and a dynamic page route to render all pages and their content.