Developer Documentation
Get up and running with Prismic using your favorite programming language or framework.
Choose your framework
Prismic supports the following frameworks:
Components
We provide components and utilities for the following libraries:
- React:
@prismicio/react - Vue:
@prismicio/vue - Svelte:
@prismicio/svelte
We recommend using these packages alongside your website’s framework.
API Client
We provide a client for fetching and manipulating your Prismic content:
You’ll learn how to use @prismicio/client throughout the guides for each framework listed above.
Core features
Learn about Prismic’s key concepts and features.
- Access Token
Query a private repository.
- Alpha Page Builder
Try Prismic's new page-building experience.
- API
Discover Prismic's API endpoints.
- Content Relationship
Data links within your repository.
- Field
A content input.
- GraphQuery
Deep fetching and selective fetching.
- Image
Render and transform images.
- Integration
Connections to a third-party data sources.
- Locales
Set localized versions of each document
- Migration (beta)
Migrate your existing content to Prismic.
- Previews
Preview drafts on your live website.
- Rich Text
Customizable text with formatting.
- Route Resolver
Generate URLs for your documents.
- Slice
A section of a webpage.
- Slice Machine
Build components with Prismic.
- Type
A document model.
- Webhooks
Fire events on repository actions.
Premium features
Some features are only available depending on your subscription.
API References
Documentation for Prismic’s API endpoints.
- Asset API
The Prismic Asset API allows you to manage your repository assets in media library.
- Authentication API
The Authentication API accepts a user email address and password and returns a user session token to use with other API endpoints.
- Document API
The Prismic Document API is an extremely fast, flexible, and powerful engine for your content.
- GraphQL API
Prismic’s GraphQL API is a read-only endpoint that allows you to perform deep fetching and selective fetching for documents from your Prismic repository.
- Migration API
The Migration API endpoint allows developers to upload documents to a Prismic repository.
- Repository API
This guide will teach you how to use the Repository API, which you'll use to retrieve basic information about your repository.
- Tags API
This guide will teach you how to use the Tags API, which you'll use to retrieve all the tags from your repository.
- Types API
This guide will teach you the basics of how to use query the Types API, which you can use to version and update your custom types.