API Reference
Our API reference contains information on how to work with our Content API, as well as our Schema, Management SDK, and other developer tools.
This section of our documentation covers:
#Basics
| Document | Contents |
|---|
| Authorization | Contains information about Public API permissions, Permanent auth tokens, and API endpoints |
| Permissions | Contains information about our advanced permissions feature, which allows you to configure granular permissions to access content from a Hygraph project. |
| Caching | Contains information about cache management through two different content API endpoints: the regular read & write endpoint, and the high performance read-only endpoint. |
| Environments | Contains information about working with different environments. |
| Errors | Contains information about common error codes. |
| Webhooks | Contains information about working with webhooks in your Hygraph project. |
| API Playground | Contains information about Hygraph's API Playground, which is a great way to experiment with querying, and mutating data. |
| Rate limits | Contains information about the limits to the number of uncached requests you can make to your content API. Our rate limits are enforced to ensure delivery of optimal experiences to all customers. |
#Schema
| Document | Contents |
|---|
| Models | Contains information about working with models. The models you create and the fields you add define your project's schema. |
| System fields | Contains information about system fields. All default and custom content types come with some managed system fields. |
| Field types | Contains information about the field types you can use in your project. It also contains information about how input types work for filtering, ordering, paginating, and mutating data. |
| Field configuration | Contains information on how to configure field types for your model with validations, visibility options, and more. |
| Enumerations | Contains information on how to work with enumerations. |
| Components | Contains information on how to work with components. A component is a pre-defined set of fields that can be reused across models and content entries. |
| Remote sources | Contains information on how to work with remote sources. With Remote Sources, our content federation utility, it's possible to add content from other systems and sources to the Hygraph API without having to migrate the content itself. |
| Remote content & data | Contains information about using remote fields to fetch external data. Use this document to learn about remote fields in the context of a regular model, and top level remote fields, which fetch data unrelated to Hygraph. |
| Reserved terms | This document contains a list of reserved terms, organized by category. Attempting to use these terms will result in a warning, informing you that you must use a different word instead. |
| Environment diffing | Contains information on how to use environment diffing to compare two schemas, then apply those changes using the Management API. |
#Content API
| Document | Contents |
|---|
| Queries | Contains information about working with queries. Hygraph automatically generates queries for fetching single and multiple entries for each defined content type belonging to your project. |
| Mutations | Contains information about working with mutations. Your project endpoint exposes GraphQL mutations you can use to modify the contents of your project. |
| Filtering | Contains information about using filters. Hygraph automatically creates filters for types you add to your content models. These filters can be applied to a single or multiple entries, and nested object fields. |
| Ordering | Contains information about ordering. When fetching multiple entries you can use the orderBy argument to define the order of the returned records. |
| Pagination | Contains information about pagination. Hygraph supports various arguments for paginating content entries. |
| Content stages | Contains information about content stages. You can create your own content stages inside the Hygraph UI, and query content from these stages, as well as publish to. |
| Localization | Contains information about localization. Hygraph boasts a flexible localization API that you can use to publish content for all or specific locales in your project. |
| Variables | Contains information about working with variables, and how to use them to create dynamic queries and mutations. |
| Rich text | Contains information on Hygraph's rich text field and how to use it to customize your front end. |
| Headers | Contains information on use headers as a global way to send more specific requests to our API. |
#Assets
| Document | Contents |
|---|
| Overview | Overview to our asset upload API reference. |
| Fetching assets | Contains information about fetching assets using our asset upload API. |
| Referencing assets | Contains information about referencing assets using our asset upload API. |
| Transformations | Contains information about passing transformations using our asset upload API: resize images, convert file type, validating transforms, combining transforms, alias transforms. |
| Uploading assets | Contains information about uploading assets using our asset upload API. |
| Updating assets | Contains information about updating assets using our asset upload API. |
| Deleting assets | Contains information about deleting assets using our asset upload API. |
| Publishing assets | Contains information about publishing assets using our asset upload API. |
| Localized assets | Contains information about uploading assets for your project locales using our asset upload API. |
| Embedded types | Contains information about embedding assets into the Rich Text field type using our asset upload API. |
#Management SDK
| Document | Contents |
|---|
| Overview | Contains information about Hygraph's Management SDK. Learn about its advantages and how it works. |
| Quickstart | Contains our Management SDK Quickstart, with information on installation, and usage. |
| Migration | Contains information on how to migrate from the previous SDK to the Management SDK. |
| Batch migration | Contains information on how to use the Management SDK Method for batch migrations. |
| Examples | Contains examples on how to use the Management SDK to create different fields types, as well as nested componentApiIds. |
| Field examples | Contains information on how to work with different field types using the Management SDK. |
| Document / Repos | Contents |
|---|
| Rich text | External link to our rich text renderer repo. |
| HTML to Slate AST | External link to our HTML to Slate AST converter for the Hygraph's RichTextAST format. |
| Gatsby Source Plugin | External link to our Gatsby Source Plugin. |