Cosmic Documentation

Read the Cosmic documentation to learn how to create, read, update, and delete Cosmic content, upload media, create automatic workflows, and extend the dashboard functionality.

Quickstart Explore API

Getting started

To get started, follow the quickstart guide and read about how to make requests for your content using the API and available SDKs. Learn how to use Cosmic with select frameworks below.

Resources

Objects

Learn about the Object model and how to create, read, update, and delete Objects.

Media

Learn about the media model and how to create, read, update, and delete media.

Queries

Learn about query methods to fetch Objects and media from your Bucket.

Object types

Learn about the Object type model and how to create, read, update, and delete Object types.

You can access all Cosmic documentation in markdown format for easy integration with Large Language Models (LLMs). View the complete documentation index optimized for LLMs. Agents should start at AI onboarding.

Get Support

Reach out to Cosmic support for any specific questions or issues. You can also join the community on the Cosmic Discord server.

FAQ

What is Cosmic?

Cosmic is a headless CMS. Content is read and written over a REST API at https://api.cosmicjs.com/v3, or through the hosted MCP server at https://mcp.cosmicjs.com. The JavaScript SDK is @cosmicjs/sdk.

Does Cosmic work with Next.js?

Yes. The App Router guide is https://www.cosmicjs.com/docs/frameworks/Nextjs.md and a short blog recipe is https://www.cosmicjs.com/docs/how-to/blog-nextjs.md.

Where is the machine-readable API?

The content API spec is https://www.cosmicjs.com/openapi.json. Agent signup, AI generation, and the webhook payload are https://www.cosmicjs.com/agent-openapi.json.

How much does Cosmic cost?

Project plans are Free ($0), Builder ($99/mo), Team ($299/mo), Business ($499/mo), Enterprise (custom pricing). Yearly billing saves 10%. Workspace plans are Small Workspace ($999/mo) and Large Workspace ($2,999/mo), and they start with a 30-day free trial. Allowances, add-on rates, and the rest of the pricing FAQ are plain text at https://www.cosmicjs.com/pricing.md.

Are API keys required, and is content private?

Each Bucket has a read key and a write key in Bucket Settings > API Access. GET requests use the read key. POST, PATCH, and DELETE use the write key as Authorization: Bearer. Do not put the write key in a browser bundle, a mobile app, or a NEXT_PUBLIC_ variable. SAML single sign-on is on Large Workspace and Enterprise. The audit log is append-only. Text versions: https://www.cosmicjs.com/security.md and https://www.cosmicjs.com/docs/dashboard/audit-log.md.

Can an agent create a Cosmic project without an existing account?

Yes. POST https://dapi.cosmicjs.com/v3/agents/sign-up provisions a free-tier project and bucket tied to a human email, with no existing Cosmic account. The human claims it with the emailed one-time code. The playbook is https://www.cosmicjs.com/docs/ai-onboarding.md.