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

Dify Knowledge (BYOK) — connector documentation

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

What Dify Knowledge (BYOK) is for

Dify Knowledge (BYOK) lets an AI assistant read your own Dify Knowledge data through the Dify Knowledge API with a key you supply (Dify knowledge base API key). Read-only: 10 tools (list_knowledge_bases, get_knowledge_base, list_documents, get_document, get_indexing_status, list_chunks, list_metadata_fields, list_knowledge_tags, get_knowledge_base_tags, list_available_models). 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.dify.ai. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Dify Knowledge. Dify Knowledge 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 knowledge bases do I have in Dify?"
  • "What retrieval settings does Dify knowledge base X use?"
  • "Which documents of Dify knowledge base X failed indexing?"
  • "How many chunks does document Y in Dify knowledge base X have?"
  • "Has Dify finished indexing batch B of knowledge base X?"
  • "Show the chunks of document Y in Dify knowledge base X"

What it does

  • list_knowledge_bases: List the knowledge bases of the workspace with document counts, word counts, embedding model and indexing technique.
  • get_knowledge_base: Get one knowledge base: embedding model, indexing technique, retrieval settings, tags and document statistics.
  • list_documents: List the documents of a knowledge base with indexing status, word count, tokens, hit count and enabled flag.
  • get_document: Get one document of a knowledge base: indexing status and latency, segment count, language, type and metadata values.
  • get_indexing_status: Show the indexing progress of the documents in one upload batch: stage and completed versus total chunks.
  • list_chunks: List the chunks (segments) of one document with content, word count, tokens, hit count, keywords and status.
  • list_metadata_fields: List the metadata fields of a knowledge base (custom and built-in) with their type and how many documents use each.
  • list_knowledge_tags: List all knowledge base tags of the workspace with the number of knowledge bases bound to each.
  • get_knowledge_base_tags: List the tags bound to one knowledge base.
  • list_available_models: List the models of a type configured in the workspace (for example text embedding or rerank models) with provider and status.

BYOK key

You bring your own Dify Knowledge Dify knowledge base API key (https://cloud.dify.ai/datasets). 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.dify.ai 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 Dify Knowledge API (api.dify.ai) with a BYOK key; documentation: https://docs.dify.ai/en/api-reference/guides/get-started. 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 Dify Knowledge. Dify Knowledge 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 Dify Knowledge account.

Built for: Worldwide. Languages: English.