Gatsby

npm i @cosmicjs/sdk
// gatsby-node.js
const { createBucketClient } = require('@cosmicjs/sdk');

exports.sourceNodes = async ({ actions, createNodeId, createContentDigest }) => {
  const cosmic = createBucketClient({
    bucketSlug: process.env.BUCKET_SLUG,
    readKey: process.env.BUCKET_READ_KEY,
  });
  const { objects } = await cosmic.objects
    .find({ type: 'posts' })
    .props('id,title,slug,metadata');

  objects.forEach((post) => {
    actions.createNode({
      ...post,
      id: createNodeId(`cosmic-post-${post.id}`),
      internal: {
        type: 'CosmicPost',
        contentDigest: createContentDigest(post),
      },
    });
  });
};

Query allCosmicPost in GraphQL after the build. Keep the keys in the environment Gatsby uses at build time.

FAQ

Is there a gatsby-source-cosmic plugin?

No official plugin. Create nodes in gatsby-node.js with @cosmicjs/sdk.

When does the content update?

On the next build. A webhook can trigger that build. See the webhooks guide.

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.