# Plenary > Plenary is a hybrid CMS with a content API, a visual page builder rendered by your own front end, and a JavaScript SDK. Plenary is a hybrid CMS: a Go API server and admin console ("the console", served at /cms on an instance) that stores structured content and visual page-builder documents, plus a JavaScript SDK (npm: @plenary/client, @plenary/react, @plenary/next, @plenary/nuxt, @plenary/core, @plenary/cli) that sites use to fetch and render that content. Notes for agents: - Every page is available as raw Markdown by appending `.md` to its URL, as listed below. - The API lives under `/api/v1` on the customer's instance URL. Reads need an API key; see Authentication. - Always pass `locale` on content reads. Plenary never falls back to another locale. - Start with Core Concepts, then the page for the task. Examples are complete, copy-pasteable builds. Getting Started: - [Introduction](https://docs.plenarycms.com/getting-started/introduction.md): What Plenary is, who it is for, the pieces that make it up, and how these docs are organized. - [Core Concepts](https://docs.plenarycms.com/getting-started/concepts.md): A glossary of the core Plenary concepts, the identifiers each one appears as in JSON, and the guide that covers it. - [Quickstart](https://docs.plenarycms.com/getting-started/quickstart.md): Go from an empty Plenary instance to published content rendered in a Next.js App Router app, using the console, curl, and @plenary/client. - [Plenary Cloud](https://docs.plenarycms.com/getting-started/cloud.md): Sign up for Plenary Cloud, find your instance URL and console, and learn what Plenary manages for you and where the account portal is. - [Self-Hosted Install](https://docs.plenarycms.com/getting-started/self-hosted.md): Run Plenary on your own infrastructure as a single Docker container with MongoDB, including configuration, secrets, volumes, first-boot admin setup, licensing, upgrades, and backups. - [Building with AI Agents](https://docs.plenarycms.com/getting-started/ai-agents.md): Point an AI coding agent at these docs, give it the right credentials, and avoid the mistakes agents most often make with Plenary. Guides: - [Content Models](https://docs.plenarycms.com/guides/content-models.md): Create and configure content models in Plenary, including kinds, keys, title fields, preview URLs, publishing and history settings, references between models, and safe deletion. - [Fields](https://docs.plenarycms.com/guides/fields.md): Add fields to a Plenary content model and configure them, including required, unique, private and localized flags, help text, conditional visibility, computed fields, objects, and lists. - [Entries & Publishing](https://docs.plenarycms.com/guides/entries-and-publishing.md): Create, edit, publish, schedule, restore, archive, and delete content entries in Plenary from the console and the API, and what public and private API keys can read at each stage. - [Localization](https://docs.plenarycms.com/guides/localization.md): Store translated content in Plenary, configure site locales, and fetch the right translation with the SDK or HTTP, including the locale resolution order and the no-fallback rule. - [Sites](https://docs.plenarycms.com/guides/sites.md): Run several websites or apps from one Plenary instance with sites, including site keys, locales and timezones, which models a site offers, site-restricted API keys, and site webhooks. - [Content Directories](https://docs.plenarycms.com/guides/content-directories.md): Organize a model's entries into folder trees and route nested URLs on the path intrinsic, including how path differs from slug, querying a subtree with $under, and what moving or deleting folders does. - [Media Library](https://docs.plenarycms.com/guides/media-library.md): Upload and organize images, video, and files in Plenary, use them in entries, generate image variants with focal-point cropping, serve private assets with signed URLs, and choose a storage backend. - [Page Builder](https://docs.plenarycms.com/guides/page-builder.md): How editors compose pages from blocks on a live canvas, and how developers store, render, extend, and style those pages with the React SDK. - [Live Preview](https://docs.plenarycms.com/guides/live-preview.md): Show editors their unsaved drafts on your own site inside the console — the model's preview URL, the PlenaryBridge component, editor origins, security, and a Next.js App Router preview route. - [Forms](https://docs.plenarycms.com/guides/forms.md): Define a form in Plenary, render it on your site with getForm, accept form entries with submitForm, and triage, export, and route them. - [Webhooks](https://docs.plenarycms.com/guides/webhooks.md): Configure webhooks that POST JSON to your endpoint when entries change or forms are submitted, and build a receiver that authenticates, deduplicates, and answers correctly. - [Transformers](https://docs.plenarycms.com/guides/transformers.md): Write JavaScript transformers that change or reject an entry while it is being saved, learn what the sandbox allows (and why there is no regex), and see tested examples. - [Users & Permissions](https://docs.plenarycms.com/guides/users-and-permissions.md): Add people to a Plenary instance, make them a super user or give them a role on each site, build roles from grants, and set up common arrangements such as a one-site editor or a form-entry reader. - [API Keys](https://docs.plenarycms.com/guides/api-keys.md): Create public and private API keys on a site, choose what each may do, restrict them by origin, rate, and expiry, and keep them safe in a web app. - [Settings](https://docs.plenarycms.com/guides/settings.md): Configure a self-hosted Plenary instance's email provider, SMS provider for sign-in codes, and media storage, and learn which settings live in plenary.yaml and which are locked on Plenary Cloud. - [Models as Code](https://docs.plenarycms.com/guides/models-as-code.md): Keep content models, forms, roles, and sites as YAML files in your repository, apply them with the console or `plenary metadata push`, and promote them between environments from CI. Examples: - [Blog with Next.js](https://docs.plenarycms.com/examples/nextjs-blog.md): Build a statically generated Next.js App Router blog from a Plenary post model with @plenary/client, including list and detail pages, metadata, rich text, and image variants. - [Page Builder Site](https://docs.plenarycms.com/examples/page-builder-site.md): A complete Next.js App Router site whose pages are built in the Plenary Page Builder, with two custom blocks, a catch-all page route, a live preview route, and the console steps to wire it up. - [Contact Form](https://docs.plenarycms.com/examples/contact-form.md): Build a Next.js App Router contact page that loads a Plenary form's definition in the browser, submits it with the public key, shows per-field errors, and includes the anti-spam fields. - [Instant Revalidation](https://docs.plenarycms.com/examples/revalidation.md): Refresh statically generated Next.js pages the moment an editor publishes, using a Plenary webhook, a secret header, and the @plenary/next revalidation handler, tested locally through a tunnel. - [Without the SDK](https://docs.plenarycms.com/examples/plain-http.md): Read Plenary content from any language over plain HTTP, with complete curl, JavaScript fetch, and Python requests examples covering authentication, locale, filtering, pagination, and errors. Reference: - [Content API](https://docs.plenarycms.com/reference/content-api.md): Every endpoint, query parameter, response shape, and error code for reading entries from Plenary over HTTP, with curl and @plenary/client side by side. - [GraphQL API](https://docs.plenarycms.com/reference/graphql.md): Read entries over GraphQL — the endpoint, how a site's schema is derived from its models, filtering, sorting, paging, nested references, public key restrictions, limits, and error codes. - [Forms API](https://docs.plenarycms.com/reference/forms-api.md): Every form endpoint with method, path, auth, request and response shapes, anti-spam fields, rate limits, and error codes, in curl and @plenary/client. - [Authentication](https://docs.plenarycms.com/reference/authentication.md): How API callers authenticate to Plenary, with public and private API keys, user access and refresh tokens, two-factor sign-in, passkeys, token lifetimes, and authentication errors. - [Single Sign-On](https://docs.plenarycms.com/reference/single-sign-on.md): Connect a Plenary instance to an OpenID Connect or SAML 2.0 identity provider such as Okta, Microsoft Entra ID, Google Workspace, Keycloak, or AD FS, control how accounts are linked or created, and read the sign-in and settings API. - [Field Types](https://docs.plenarycms.com/reference/field-types.md): Every Plenary field type with its identifier, the JSON value you read and write, its settings, UI and validation options, what the server enforces, and how it can be queried. - [Model YAML](https://docs.plenarycms.com/reference/model-yaml.md): The YAML file format for content models and forms used by plenary metadata pull/push and the console's YAML import and export, with every key and complete annotated examples. - [Webhook Events](https://docs.plenarycms.com/reference/webhook-events.md): Every webhook event Plenary sends, when it fires, its full JSON payload, the request headers, the expected responses, and the retry schedule. - [Permissions](https://docs.plenarycms.com/reference/permissions.md): Every capability string Plenary checks, which grant filters each accepts, the grant shape, the evaluation rules, and what public and private API keys may hold. - [Errors](https://docs.plenarycms.com/reference/errors.md): The Plenary API error envelope, how to handle errors in the SDK and the CLI, and every error code the API returns, with its HTTP status and meaning, grouped by area. - [CLI](https://docs.plenarycms.com/reference/cli.md): Complete reference for @plenary/cli, the `plenary` command - installation, configuration and credentials, every command and flag, output formats, and exit codes. - [Metrics](https://docs.plenarycms.com/reference/metrics.md): What Plenary counts, how delivery traffic is measured, and every metrics endpoint behind the console dashboard, with parameters, responses, and errors. - [Licensing](https://docs.plenarycms.com/reference/licensing.md): How self-hosted Plenary licenses work - the free tier and its limits, license kinds, installing a license from an environment variable, file, or the console, what happens when a license expires, and every license error code. SDK: - [Overview](https://docs.plenarycms.com/sdk/overview.md): The six @plenary npm packages, what each one does, which to install for your project, version compatibility, and the shared client configuration. - [@plenary/core](https://docs.plenarycms.com/sdk/core.md): Reference for @plenary/core — the page document types, component and prop definition types, the responsive style model and CSS compiler, the preview protocol types, and editor-origin matching. - [@plenary/client](https://docs.plenarycms.com/sdk/client.md): Full reference for @plenary/client, covering createClient options, every method with its signature and errors, the query options, media lookup, webhook verification helpers, and exported types. - [@plenary/react](https://docs.plenarycms.com/sdk/react.md): Reference for @plenary/react — registering components and design tokens, rendering page documents, the built-in blocks, media resolution, and the PlenaryBridge live-preview component. - [@plenary/next](https://docs.plenarycms.com/sdk/next.md): Full reference for @plenary/next, covering the App Router and Pages Router revalidation handlers, their options and responses, the cache-tagged fetch, tag names, and the webhook secret. - [@plenary/nuxt](https://docs.plenarycms.com/sdk/nuxt.md): Full reference for @plenary/nuxt, covering the Nuxt module, the revalidation server handler, its options and responses, what it purges from Nitro's cache and what it cannot reach, and the webhook secret. - [Changelog](https://docs.plenarycms.com/sdk/changelog.md): What changed in each release of the Plenary JavaScript SDK packages and the plenary CLI, with the changes that need action on upgrade called out. ## Documentation Sets - [Abridged documentation](https://docs.plenarycms.com/llms-small.txt): a compact version of the documentation for Plenary, with non-essential content removed - [Complete documentation](https://docs.plenarycms.com/llms-full.txt): the full documentation for Plenary - [Guides](https://docs.plenarycms.com/_llms-txt/guides.txt): feature-by-feature explanations of Plenary - [Examples](https://docs.plenarycms.com/_llms-txt/examples.txt): complete, copy-pasteable Next.js and HTTP builds - [API and SDK reference](https://docs.plenarycms.com/_llms-txt/api-and-sdk-reference.txt): exhaustive endpoint, error, field type, and SDK signature reference ## Notes - The complete documentation includes all content from the official documentation - The content is automatically generated from the same source as the official documentation