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

Outline (BYOK) — connector documentation

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

What Outline (BYOK) is for

Outline (BYOK) lets an AI assistant read your own Outline data through the Outline API with a key you supply (API key (starts with ol_api_; cloud-hosted Outline only)). Read-only: 11 tools (get_auth_info, list_collections, get_collection, list_documents, search_document_titles, search_documents, get_document, list_document_comments, list_document_revisions, list_groups, list_templates). 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 app.getoutline.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Outline. Outline 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 Outline workspace is my API key connected to?"
  • "Which collections does our Outline wiki have?"
  • "Show me Outline collection 3f1a2b4c"
  • "Which documents were updated recently in Outline?"
  • "Find the Outline documents with onboarding in the title"
  • "What does our Outline wiki say about refunds?"

What it does

  • get_auth_info: Show the Outline user and workspace the API key belongs to; a quick check that the key works.
  • list_collections: List the collections (top-level sections) of the knowledge base with description, permission and archive state. Paged by offset and limit.
  • get_collection: Get one collection by id with its description, colour, permission and dates.
  • list_documents: List documents (text not included) with title, link, collection and dates, optionally of one collection, sorted by a field. Paged by offset and limit.
  • search_document_titles: Search document titles by keywords; returns matching documents without their text. Paged by offset and limit.
  • search_documents: Full-text search of documents with a context snippet and the matching document (text included, so keep the limit small).
  • get_document: Get one document by id or url id with its Markdown text, title, collection and dates.
  • list_document_comments: List comments on documents, optionally of one document, with thread parent, resolved time and the anchored text. Paged by offset and limit.
  • list_document_revisions: List the revision history of one document (titles and times, not the content). Paged by offset and limit.
  • list_groups: List user groups with member counts (the groups used to give collection access).
  • list_templates: List document templates, optionally of one collection. Paged by offset and limit.

BYOK key

You bring your own Outline API key (starts with ol_api_; cloud-hosted Outline only) (https://www.getoutline.com/developers). 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 app.getoutline.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 Outline API (app.getoutline.com) with a BYOK key; documentation: https://www.getoutline.com/developers. 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 Outline. Outline 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 Outline account.

Built for: Worldwide. Languages: English.