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

Umbraco Heartcore (BYOK) — connector documentation

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

What Umbraco Heartcore (BYOK) is for

Umbraco Heartcore (BYOK) lets an AI assistant read your own Umbraco Heartcore data through the Umbraco Heartcore API with a key you supply (Heartcore API key (needed when the delivery API is protected)). Read-only: 11 tools (get_root_content, get_content, get_content_by_url, list_content_by_type, list_content_children, list_content_descendants, list_content_ancestors, search_content, get_root_media, get_media, list_media_children). 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 cdn.umbraco.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Umbraco Heartcore. Umbraco Heartcore 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 are the top-level pages of my Umbraco Heartcore site?"
  • "Show Umbraco Heartcore content item ec4aafcc"
  • "Which Heartcore content item is at /about/?"
  • "List all product pages in my Umbraco Heartcore project"
  • "What pages are under the Heartcore content item ec4aafcc?"
  • "List everything below the Heartcore content item ec4aafcc"

What it does

  • get_root_content: Get the published content items at the root of the content tree with name, content type alias, URL and dates.
  • get_content: Get one published content item by ID with its properties. Depth controls how many levels of referenced content and media are resolved (0 to 5).
  • get_content_by_url: Get the published content item that lives at a site URL path, for example /products/.
  • list_content_by_type: List published content items of one content type alias with paging (_totalItems, _totalPages).
  • list_content_children: List the published children of a content item with paging.
  • list_content_descendants: List all published descendants of a content item (children, grandchildren and so on) with paging.
  • list_content_ancestors: List the published ancestors of a content item up to the root, for breadcrumbs.
  • search_content: Search published content by a term with paging.
  • get_root_media: Get the media items and folders at the root of the media tree.
  • get_media: Get one media item by ID: type, name, URL, file size and image dimensions.
  • list_media_children: List the children of a media folder with paging.

BYOK key

You bring your own Umbraco Heartcore Heartcore API key (needed when the delivery API is protected) (https://docs.umbraco.com/umbraco-heartcore/getting-started/backoffice-users-and-api-keys). 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 cdn.umbraco.io 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 Umbraco Heartcore API (cdn.umbraco.io) with a BYOK key; documentation: https://docs.umbraco.com/umbraco-heartcore/api-documentation/content-delivery. 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 Umbraco Heartcore. Umbraco Heartcore 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 Umbraco Heartcore account.

Built for: Worldwide. Languages: English.