Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Cosmic (BYOK) — connector documentation

  • MCP endpoint: https://byok-cosmic.connectorbay.com/mcp
  • REST API: POST https://byok-cosmic.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-cosmic.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Cosmic bucket read key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-cosmic.connectorbay.com/health · Tool schemas: https://byok-cosmic.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-cosmic · agent@connectorbay.com

What Cosmic (BYOK) is for

Cosmic (BYOK) lets an AI assistant read your own Cosmic data through the Cosmic API with a key you supply (bucket read key). Read-only: 9 tools (list_object_types, get_object_type, list_objects, get_object, list_object_revisions, get_object_revision, list_media, get_media_item, list_blocks). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.cosmicjs.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Cosmic. Cosmic and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "What content types does my Cosmic bucket have?"
  • "Show the 'blog-posts' content type in Cosmic"
  • "List my Cosmic blog posts"
  • "Show Cosmic object 5ff75368c2dfa81a91695cec"
  • "What is the revision history of this Cosmic object?"
  • "Show this revision of the Cosmic object"

What it does

  • list_object_types: List the bucket's object types (content models) with their fields (metafields), singleton flag and locales.
  • get_object_type: Get one object type by its slug, with all its metafield definitions.
  • list_objects: List or filter the bucket's objects (content entries). Filter with a JSON query such as {"type":"blog-posts"}; page with limit and skip or the last id.
  • get_object: Get one object by its ID with its fields, status, locale and dates.
  • list_object_revisions: List the saved revisions of one object, newest first by default, with status, title and dates.
  • get_object_revision: Get one revision of an object by its revision ID, including the stored fields.
  • list_media: List the bucket's media library files with name, type, size, dimensions, alt text and URLs. Filter with a JSON query.
  • get_media_item: Get one media library file by its ID with URLs, dimensions and alt text.
  • list_blocks: List the reusable content blocks defined in the bucket.

BYOK key

You bring your own Cosmic bucket read key (https://www.cosmicjs.com/docs/api/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.cosmicjs.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Cosmic API (api.cosmicjs.com) with a BYOK key; documentation: https://www.cosmicjs.com/docs/api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Cosmic. Cosmic and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Cosmic account.

Built for: Worldwide. Languages: English.