API Client
Official TypeScript SDK for Paragraph CMS. Connect apps with API keys to fetch, list, create, and update content across pages, collections, and locales.
Grzegorz
The API Client is the official TypeScript SDK for Paragraph CMS. It gives external apps a clean way to work with content stored in the CMS, whether that means a website frontend, a server-side integration, or an internal automation.
It is designed to work with API Keys, and it is the main bridge between editorial work inside Paragraph CMS and the applications that deliver that content to end users.
What teams use it for
The API Client is most useful when a frontend or service needs to:
fetch pages by slug, collection, or locale,
list content for a section like a blog or docs area,
read collections, labels, statuses, data models, locales, or media,
or create and update content programmatically.
That makes it a natural fit for projects built with Next.js, Astro, React Router, Nuxt, and SvelteKit.
Connect it with an API key
The usual setup is simple: create a key in Paragraph CMS, add it to your application, and let the client handle requests to the public API.
That keeps the editorial surface and the delivery surface separate. Teams can manage content in Pages, Collections, and Data Models, then use the client in their app code to read or update that content where it is needed.
Close to the editorial workflow
Paragraph CMS also surfaces code examples inside the product, which makes it easier to move from content setup to implementation. Collections, pages, labels, and statuses can all feed directly into frontend or automation work powered by the client.
This is especially useful when the same team owns both the CMS structure and the site or app that consumes it.
Works well with other delivery tools
The API Client is also the base layer for the SEO Client, which builds site-level SEO files such as sitemaps and feeds from the same content source.
