Cosmic REST API

The Cosmic REST API and available clients help you manage content for your websites and applications. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your private keys or credentials in any public website's client-side code). JSON is returned by all API responses, including errors.

The API is fully CRUD capable, allowing you to perform Create, Read, Update, and Delete requests to your Cosmic Buckets.

Quick Tip

For a quick reference to get content from your Bucket, click the "Developer Tools" button found on select pages in your Bucket Dashboard (opens new window).

Getting Started

Create a Cosmic account (opens new window) and get familiar with the Cosmic Dashboard.

API Endpoint

You can make direct calls to the REST API from the following base URL. Current version is v1.

https://api.cosmicjs.com/v1

Status Check

You can check on the API system status via the Cosmic status page (opens new window) and via the following endpoint:

https://api.cosmicjs.com/status

Node.js Installation

Install the Cosmic NPM Module (opens new window) to follow examples using Node.js

npm i cosmicjs

Terms

These docs assume you understand the core concepts of Cosmic including Buckets, Object Types and Objects. For a brief overview of these terms, see the Getting Started guide (opens new window).