API Keys

Manage Paragraph CMS API keys per organization to connect apps, websites, and automations. Create, rename, search, and delete keys securely.

GrzegorzGrzegorz
API Keys

API Keys let external applications connect to Paragraph CMS without using the dashboard directly. They are managed per organization and act as the handoff point between content operations and delivery code.

This is the feature teams use when they want to connect a website, app, automation, or SDK such as the API Client or SEO Client.

Create keys for real integrations

The API Keys view lives in the developer settings area and is designed to stay simple:

  • create a new key,

  • search existing keys,

  • rename a key,

  • and delete a key that is no longer needed.

The table shows the key name, when it was created, and its rate limit, which makes it easier to keep integrations organized as a workspace grows.

Screenshot to add: /screenshots/features/api-keys-settings-table.png
Show the API Keys settings page with the key name, created date, rate limit, and edit or delete actions.
Alt: Paragraph CMS API Keys settings table showing key names, creation dates, and rate limits.
Caption: API keys are managed per organization from the developer settings area.

Shown once after creation

After a key is created, Paragraph CMS shows the raw value in a dedicated dialog with a copy button. That is the only time the full secret is shown, so teams should save it immediately where their application can use it.

New keys currently start without expiration and use a default rate limit of 5 req/s, which is a sensible starting point for most integrations.

Paragraph CMS API key created dialog with one-time key value and copy button.
Paragraph CMS API key created dialog with one-time key value and copy button.

The connection point for delivery

API Keys are what connect editorial work inside Paragraph CMS to production delivery outside it. Teams manage content in the CMS, then pass an API key to the application that needs access to that content.

That makes API Keys a small feature with outsized importance, especially when paired with the API Client, SEO Client, and framework guides such as Next.js Quickstart.

Related

The best way to understand is to try

Explore Paragraph CMS live and see how it helps you create, manage, and publish content faster.