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

HelpDocs (BYOK) — connector documentation

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

What HelpDocs (BYOK) is for

HelpDocs (BYOK) lets an AI assistant read your own HelpDocs data through the HelpDocs API with a key you supply (HelpDocs API key (Read scope or higher)). Read-only: 9 tools (list_articles, get_article, get_article_versions, search_articles, list_categories, get_category, get_top_articles, get_search_terms, get_article_feedback). 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.helpdocs.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HelpDocs. HelpDocs 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:

  • "Which articles are in my HelpDocs knowledge base?"
  • "Show the HelpDocs article about logging in"
  • "What older versions exist of a HelpDocs article?"
  • "Search my HelpDocs knowledge base for 'refund'"
  • "What categories does my HelpDocs knowledge base have?"
  • "Show the HelpDocs category with a given id"

What it does

  • list_articles: List knowledge base articles with title, category, tags, publish state and dates. Article bodies are left out unless asked for.
  • get_article: Get one article with its title, HTML body, tags, category, publish state and URL.
  • get_article_versions: List the saved versions of one article (language, version number, whether it is current, author id, body and time).
  • search_articles: Search the knowledge base for a phrase and return the top matching articles.
  • list_categories: List the knowledge base categories with title, description and parent category.
  • get_category: Get one category's title, description and parent.
  • get_top_articles: Show how many views each article received in a period, most viewed first.
  • get_search_terms: Show the phrases visitors searched for in a period with how often and how many results they returned on average.
  • get_article_feedback: Show visitor feedback on articles in a period: overall positive, neutral and negative counts, a happiness score and per-article results.

BYOK key

You bring your own HelpDocs HelpDocs API key (Read scope or higher) (https://apidocs.helpdocs.io/article/caacxCUso6-authenticating-api-requests). 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.helpdocs.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 HelpDocs API (api.helpdocs.io) with a BYOK key; documentation: https://apidocs.helpdocs.io/. 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 HelpDocs. HelpDocs 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 HelpDocs account.

Built for: Worldwide. Languages: English.