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:

BasicsAnchor

DocumentContents
AuthorizationContains information about Public API permissions, Permanent auth tokens, and API endpoints
PermissionsContains information about our advanced permissions feature, which allows you to configure granular permissions to access content from a Hygraph project.
CachingContains information about cache management through two different content API enpdoints: the regular read & write endpoint, and the high performance read-only endpoint.
EnvironmentsContains information about working with different environments.
ErrorsContains information about common error codes.
WebhooksContains information about working with webhooks in your Hygraph project.
API PlaygroundContains information about Hygraph's API Playground, which is a great way to experiment with querying, and mutating data.
Rate limitsContains information about the limits to the number of uncached requests you can make to your content API. Our rate limjits are enforced to ensure delivery of optimal experiences to all customers.

SchemaAnchor

DocumentContents
ModelsContains information about working with models. The models you create and the fields you add define your project's schema.
System fieldsContains information about system fields. All default and custom content types come with some managed system fields.
Field typesContains 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 configurationContains information on how to configure field types for your model with validations, visibility options, and more.
EnumerationsContains information on how to work with enumerations.
ComponentsContains 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 sourcesContains 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.
Reserved termsThis 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.

Content APIAnchor

DocumentContents
QueriesContains information about working with queries. Hygraph automatically generates queries for fetching single and multiple entries for each defined content type belonging to your project.
MutationsContains information about working with mutations. Your project endpoint exposes GraphQL mutations you can use to modify the contents of your project.
FilteringContains 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.
OrderingContains information about ordering. When fetching multiple entries you can use the orderBy argument to define the order of the returned records.
PaginationContains information about pagination. Hygraph supports various arguments for paginating content entries.
Content stagesContains 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.
LocalizationContains information about localization. Hygraph boasts a flexible localization API that you can use to publish content for all or specific locales in your project.
AssetsContains information about assets. With inbuilt Digital Asset Management (DAM), the Asset model is included with every project.
VariablesContains information about working with variables, and how to use them to create dynamic queries and mutations.
Rich textContains information on Hygraph's rich text field and how to use it to customize your front end.

Developer toolsAnchor

Document / ReposContents
Management SDKContains information about Hygraph's Management SDK. Learn about its advantages, installation, usage, how to migrate to it, and access examples.
Rich textExternal link to our rich text renderer repo.
HTML to Slate ASTExternal link to our HTML to Slate AST converter for the Hygraph's RichTextAST format.
Gatsby Source PluginExternal link to our Gatsby Source Plugin.