Frequently Asked Questions

API Error Codes & Troubleshooting

What types of error codes does Hygraph return for API requests?

Hygraph uses conventional HTTP response codes for API requests. Successful requests return codes in the 2xx range, while errors are indicated by codes in the 4xx and 5xx ranges. Common error codes include 400 (Bad Request), 401 (Unauthorized), 402 (Payment Required), 403 (Unauthorized Request), 404 (Not Found), 413 (Payload Too Large), 429 (Too Many Requests), and 500 (Internal Server Error). Each code corresponds to a specific issue, such as invalid query arguments, missing permissions, exceeded limits, or server-side problems. For a full list and details, see the Hygraph Error Codes Documentation.

What does a 400 Bad Request error mean in Hygraph?

A 400 Bad Request error typically occurs when there is a client-side validation issue, such as missing required arguments in your GraphQL query or a malformed Permanent Auth Token. For example, if your Permanent Auth Token is not a valid JWT, you will receive a 400 error. Review your query and authentication details to resolve this error. More details are available in the Hygraph documentation.

How do I resolve a 401 Unauthorized error in Hygraph?

A 401 Unauthorized error means the endpoint you requested requires a valid Permanent Auth Token, or the environment may not exist for your project. Ensure you have provided a valid token and that your environment is correctly configured. For more guidance, refer to the Authorization documentation and Permanent Auth Tokens guide.

What causes a 402 Payment Required error and how can I fix it?

A 402 Payment Required error occurs when you exceed your project's API operations or asset traffic limits, or after a trial period has expired. To resolve this, enable billing under your project's settings to allow for overlimit billing or upgrade your subscription. The error message will indicate the exceeded limits. For more details, see Hygraph's documentation.

What does a 403 Unauthorized Request error mean?

A 403 Unauthorized Request error indicates that the user needs more permissions for either the Content API or the Management API. Review your roles and permissions settings to ensure you have the necessary access. Helpful resources include the Roles and Permissions guide and Permissions documentation.

How do I resolve a 413 Payload Too Large error?

This error occurs when your request size exceeds the allowed limit for GraphQL queries in shared regions. To resolve, reduce the size of your query or mutation. Rate limits depend on your subscription plan and can be lifted on dedicated clusters and enterprise plans. For more information, see API rate limits documentation or contact sales for dedicated options.

What should I do if I get a 429 Too Many Requests error?

A 429 error means you have exceeded the rate limit for GraphQL queries in shared regions. Retry your request after a brief delay or reduce the volume of concurrent requests. Rate limits vary by subscription plan and can be lifted on dedicated clusters and enterprise plans. For more details, see API rate limits documentation.

How do I troubleshoot a 500 Internal Server Error?

A 500 Internal Server Error indicates a problem on Hygraph's side. If you encounter this error, check the Hygraph status page for updates. If the issue persists, contact support and provide the requestId from your error response for faster troubleshooting.

What information should I provide when contacting Hygraph support about an API error?

When contacting Hygraph support, include the requestId from your error response, details about the API request, and any relevant error messages. This helps the support team diagnose and resolve your issue more efficiently.

Features & Capabilities

What are the key features of Hygraph?

Hygraph offers a range of features including Smart Edge Cache for enhanced performance, content federation to integrate data from multiple sources, advanced Rich Text formatting, custom roles for granular access control, project backups, and a user-friendly interface. It is GraphQL-native, developer-friendly, and supports seamless integration with eCommerce, localization, and other systems. For more, see Hygraph Features.

How does Hygraph ensure high performance for content delivery?

Hygraph delivers exceptional performance through its Smart Edge Cache, high-performance endpoints, and optimized GraphQL API. These features enable faster content delivery and reliability, especially for businesses with high traffic and global audiences. For more details, see the performance improvements blog post.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications ensure robust security and adherence to international standards. For more, visit the security features page.

What security features does Hygraph offer?

Hygraph provides granular permissions, SSO integrations, audit logs, encryption at rest and in transit, regular backups, and enterprise-grade compliance features. Customers can also access a security and compliance report for certified infrastructure. For more details, see the security report.

Pricing & Plans

What is Hygraph's pricing model?

Hygraph offers a Free Forever Developer Account, self-service plans (e.g., Growth Plan at $299/month or $199/month billed annually), and custom enterprise pricing starting at $900/month. Plans include 1,000 entries, with add-ons available for additional entries and locales. For full details, visit the Hygraph Pricing Page.

Use Cases & Benefits

Who can benefit from using Hygraph?

Hygraph is ideal for developers, product managers, and marketing teams in industries such as ecommerce, automotive, technology, food and beverage, manufacturing, transportation, staffing, and science. It supports organizations seeking to modernize legacy tech stacks, scale globally, and streamline content operations. For more, see Hygraph Case Studies.

What business impact can customers expect from using Hygraph?

Customers can expect improved speed-to-market, enhanced customer engagement, increased revenue, cost efficiency, and scalability. For example, Komax achieved 3x faster time-to-market, Samsung saw a 15% increase in customer engagement, and Stobag increased online revenue share from 15% to 70%. For more success stories, visit Hygraph Case Studies.

Support & Implementation

What support and training resources are available for Hygraph customers?

Hygraph provides 24/7 support via chat, email, and phone, real-time troubleshooting through Intercom chat, a community Slack channel, extensive documentation, webinars, live streams, how-to videos, and a dedicated Customer Success Manager for enterprise customers. The onboarding process includes introduction calls, account provisioning, and technical/content kickoffs. For more, see Hygraph Documentation.

How long does it take to implement Hygraph and how easy is it to start?

Implementation time varies by project scope. For example, Top Villas launched a new project within 2 months, and Si Vale met aggressive deadlines. Hygraph offers a free API Playground, free developer account, and structured onboarding to help teams start immediately. Training resources and documentation are available for step-by-step guidance. For more, see Top Villas Case Study and Si Vale Case Study.

Customer Success Stories

Can you share specific case studies or success stories of customers using Hygraph?

Yes, Hygraph has helped companies like Komax (3x faster time-to-market), AutoWeb (20% increase in website monetization), Dr. Oetker (global consistency with MACH architecture), Samsung (15% increase in customer engagement), Stobag (online revenue share from 15% to 70%), and Burrow (product inventory management). For more, visit the Hygraph Case Studies Page.

Technical Requirements & Maintenance

How does Hygraph handle maintenance, upgrades, and troubleshooting?

Hygraph is cloud-based, so all deployment, updates, security, and infrastructure maintenance are managed by Hygraph. Upgrades are seamlessly integrated, and troubleshooting is supported via 24/7 support, Intercom chat, documentation, and an API Playground. Enterprise customers receive a dedicated Customer Success Manager. For more, see Hygraph Documentation.

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs

#Errors

#Overview

Hygraph uses conventional HTTP responses codes when returning API requests.

Codes in the 2xx range refer to a successful request, whereas responses in the 4xx range indicate there was an error due to the information you provided, such as invalid query arguments, or auth token.

CodeDescription
200OK - Successful response
400Bad request - Typically due to invalid query arguments
401Unauthorized - Usually no valid Permanent Auth Token was provided
402Payment required - Typically due to an expired trial or API/assetTraffic exceeded
403Unauthorized request - The user needs more permissions
404Not Found - Typically invalid endpoint or environment requested
413Payload too large - Your request size exceeds the allowed limit
429Too many requests - You're making too many requests, slow down
500Internal Server Error - Something went wrong on our side

A typical GraphQL error will look like the below. The format of the error is typical for any 400 query or mutation request.

{
"errors": [
{
"message": "input:1: Field \"idd\" is not defined by type PostWhereInput. Did you mean id?\n"
}
],
"data": null,
"extensions": {
"requestId": "ckff8k1tc0nsg0150cssdkzxm"
}
}

It is clear from the error above that the field idd is not part of the Input Type.

#400: Bad request

Hygraph will return a 400 if there is an error with the request. 400 errors are typically thrown when there is a client-side validation error, such as a missing required argument in your GraphQL query, or a malformed Permanent Auth Token.

#401: Unauthorized

The endpoint you requested requires a valid Permanent Auth Token, or a environment may not exist for this project.

#402: Payment required

Exceeding the API operations and/or the asset traffic limit results in the API being blocked until the new billing period starts.

Queries will return the following 402 error:

You have exceeded the limits of your project's subscription. To continue using your API, please enable billing under your project's settings to allow for overlimit billing.

You may also get this error after a trial period has expired.

#403: Unauthorized request

The user needs more permissions for either the Content API or the Management API.

#413: Payload too large

To ensure delivery of optimal experiences to all customers, an API limit is enforced for request sizes on all GraphQL queries for the shared regions. The rate limiting depends on the current load of the shared region and the subscription plan. These limits can be lifted on dedicated clusters and enterprise plans. Please contact sales for further information.

You'll get a 413 when you exceed the limit for request size, and you will get a response with the following payload:

{
"errors": [
{
"message": "Payload Too Large"
}
],
"data": null
}

To resolve this issue, reduce the size of your GraphQL query or mutation.

#429: Too many requests

To ensure delivery of optimal experiences to all customers, a rate limit is enforced on all GraphQL queries for the shared regions. The rate limiting depends on the current load of the shared region and the subscription plan. These limits can be lifted on dedicated clusters and enterprise plans. Please contact sales for further information.

You'll get a 429 error when you exceed the rate limit.

For exceeding the number of requests per second limit, you will get a response with the following payload:

{
"errors": [
{
"message": "Too Many Requests"
}
],
"data": null
}

To resolve this issue, retry the request after a brief delay.

For exceeding the concurrent requests limit, you will get a response with the following payload:

{
"errors": [
{
"message": "Concurrent operations limit exceeded"
}
],
"data": null
}

To resolve this issue, reduce the volume of your concurrent requests.

#500: Internal server error

500s errors could happen in multiple scenarios, whenever there's something wrong on our side.