Technical References

This is the home for all of Prismic's advanced technical documentation, including technical references for the Rest API, GraphQL API, and development kits.

Getting Started

These are advanced technical references. If you are a developer getting started on your first project with Prismic, we recommend that you start with one of our technology guides.

Work in Progress

This page is a work in progress. More references will be added with time.

APIs

Rest API

A technical overview of Prismic's Rest API, including a full predicate reference.

Custom Types API

A technical overview of Prismic's Custom Types API.

Tags API

A technical overview of Prismic's Tags API.

GraphQL

A Technical Reference for the GraphQL API is in progress. In the meantime, see our comprehensive guide to the GraphQL API.

SDKs

prismic-cli

A Node CLI for developing JavaScript apps with Prismic. Includes utilities for Slice Machine.

@prismicio/client

A JavaScript kit for querying the Prismic Rest API.

@prismicio/helpers

@prismicio/helpersprovide a set of helpers to render data from the Prismic API.

@prismicio/react

The official Prismic package for creating web apps with Prismic and React.

@prismicio/vue

Our kit for developing Prismic projects with Vue.js.

vue-slicezone

vue-slicezone provides a component named slice-zone to render Slices from Prismic.

next-slicezone

next-slicezone allows you to render Slices, query documents, and build routes.

gatsby-source-prismic

gatsby-source-prismic allows you to pull data from your Prismic repository.

gatsby-plugin-prismic-previews

gatsby-plugin-prismic-previews helps you to Integrate live Prismic previews into your Gatsby project.

prismic-dom

A JavaScript kit for templating Prismic content.

Note: This collection is a work in progress. More technical references will be added over time.

Was this article helpful?

Not really

Yes, Thanks

Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum or using the feedback form above.