Build with Paragraph

Integrate Paragraph into your application with the REST API, TypeScript SDK, CLI, MCP server, and agent skills.

Paragraph provides an API for building applications on top of its publishing platform. Access publication data, manage posts, work with coins, and integrate user profiles, all through a simple REST API or our TypeScript SDK.

A few things to know before you start:

• The API is in alpha. There may be breaking changes until we finalize the design.
• The API is rate-limited. If you're hitting rate limits and want to request an increase, reach out to support@paragraph.com.
• Some endpoints require authentication via an API key. Generate one in the app at app.paragraph.com under Settings -> Publication -> Developer.

Pick your tool

TypeScript SDK
Install our TypeScript SDK and start building in minutes with full type safety and intuitive methods.
CLI
Manage posts, publications, and subscribers from the command line. Works with AI agents and CI pipelines.
MCP server
Let AI agents interact with Paragraph directly via the Model Context Protocol.
Agent skills
Install portable skills that teach any AI agent how to use the Paragraph API, CLI, or MCP server.

The REST API

Prefer raw HTTP? The API is served at https://public.api.paragraph.com/api. Authenticated endpoints take your API key as a Bearer token in the Authorization header.

Every endpoint is described in the OpenAPI spec, which you can also use for code generation and API exploration. The spec lives in the SDK repository.

Core features

• Publications: access publication metadata, settings, and content collections.
• Posts: fetch posts with pagination, filtering, and full content support.
• Coins: integrate coin functionality for monetization and community support.
• User profiles: retrieve user data including wallet addresses and Farcaster profiles.

Use with AI tools

Building with an AI assistant like Claude Code, Cursor, or ChatGPT? A few things make that easier:

• This docs site is agent-readable. We serve llms.txt and llms-full.txt, and every page has a Markdown variant (append .md to any page URL). Paste llms-full.txt into your LLM conversation to give it complete knowledge of Paragraph's API endpoints, data models, and capabilities.
• The MCP server connects agents directly to Paragraph, with hosted and local options.
• The agent skills teach agents the CLI, REST API, SDK, and MCP server, including commands with examples, JSON response shapes, and common patterns.
• The CLI is designed for agent and programmatic usage. All commands support --json for structured output.

Resources

SDK on GitHub
Explore the SDK source code, contribute, or report issues.
OpenAPI spec
The complete API surface, ready for code generation and exploration.

Manage your account
Account settings, publication details, team permissions, and taking your data with you.
TypeScript SDK
Install the Paragraph SDK and query publications, posts, coins, and user profiles with full type safety.