Cosmic Documentation

For Agents

If you are an AI agent: start at https://www.cosmicjs.com/docs/agent-skills.md. It includes a one-curl signup flow (POST /v3/agents/sign-up) that provisions a free-tier Cosmic project + bucket tied to a human's email, without any prior account.

Introduction

You can access all of our documentation as plain text markdown files by adding .md to the end of any url. For example, you can find the plain text version of the docs homepage at https://www.cosmicjs.com/docs/index.md. For a single concatenated dump of every docs page, see https://www.cosmicjs.com/docs/llms-full.txt.

Get started

• Introduction: Get an overview of Cosmic and its features.
• Quickstart: Get up and running with Cosmic quickly.
• Agent Skills: Agent onboarding for Cosmic: signup flow that provisions a free-tier project + bucket tied to a human email (POST /v3/agents/sign-up), claim via emailed OTP, plus install of the Cosmic SDK rules file for AI coding assistants.
• MCP Server: MCP server for managing Cosmic content directly through AI assistants. Hosted endpoints at https://mcp.cosmicjs.com/v1/buckets/{bucket-slug} (bucket tools: objects, media, types, AI gen) and https://mcp.cosmicjs.com/v1/agent (signup tools: cosmic_agent_signup, cosmic_agent_verify, cosmic_agent_status). Self-hosted via npx @cosmicjs/mcp.
• Frameworks: Learn how to integrate Cosmic with popular frameworks.
• Examples: See practical examples of Cosmic implementations.

Dashboard

• Introduction: Understand how to use the introduction section of the Cosmic dashboard.
• Projects: Understand how to use the projects section of the Cosmic dashboard.
• Buckets: Understand how to use the buckets section of the Cosmic dashboard.
• Workspaces: Understand how to use the workspaces section of the Cosmic dashboard.
• Search: Understand how to use the search section of the Cosmic dashboard.
• Account: Understand how to use the account section of the Cosmic dashboard.
• Cosmic Pages: Understand how to use the cosmic pages section of the Cosmic dashboard.
• AI: Understand how to use the ai section of the Cosmic dashboard.
• Agents: Understand how to use the agents section of the Cosmic dashboard.
• Workflows: Understand how to use the workflows section of the Cosmic dashboard.
• Application Workflows: Understand how to use the application workflows section of the Cosmic dashboard.
• Chrome Extension: Explore chrome extension in Cosmic.

API reference

• Introduction: Explore introduction in Cosmic.
• Authentication: Reference for the authentication API endpoint and functionality.
• Agents: REST reference for the Agents API: POST /v3/agents/sign-up (provision a project + bucket tied to a human email, no prior account needed), POST /v3/agents/verify (submit the OTP from the claim email), GET /v3/agents/status (check claim status, limits, and recover bucket keys). Includes the agent_key (agk_) auth model and the unclaimed-mode 402 error code agent_unclaimed_limit.
• Request limits: Reference for the request limits API endpoint and functionality.
• Errors: Reference for the errors API endpoint and functionality.
• Object types: Reference for the object types API endpoint and functionality.
• Objects: Reference for the objects API endpoint and functionality.
• Revisions: Reference for the revisions API endpoint and functionality.
• Metafields: Reference for the metafields API endpoint and functionality.
• Media: Reference for the media API endpoint and functionality.
• AI: Reference for the ai API endpoint and functionality.
• Queries: Reference for the queries API endpoint and functionality.
• Webhooks: Reference for the webhooks API endpoint and functionality.
• Localization: Reference for the localization API endpoint and functionality.