# NeetoKB Docs

> Developer docs for NeetoKB: the REST API, the CLI and the MCP server.

- [NeetoKB API](https://apidocs.neetokb.com/api/introduction.md): Welcome to the NeetoKB API documentation.
- [Workspace subdomain](https://apidocs.neetokb.com/api/workspace-subdomain.md): Learn how to find your workspace subdomain.
- [Authentication](https://apidocs.neetokb.com/api/authentication.md): Learn how to authenticate your requests to the NeetoKB API using API keys.
- [Pagination](https://apidocs.neetokb.com/api/pagination.md): Learn how to handle paginated responses in the NeetoKB API.
- [HTTP response codes](https://apidocs.neetokb.com/api/response-codes.md): Learn about the HTTP status codes returned by the NeetoKB API.
- [Getting the article ID](https://apidocs.neetokb.com/api/getting-article-id.md): Understand how to retrieve article identifiers for use in your API calls.
- [Getting the category ID](https://apidocs.neetokb.com/api/getting-category-id.md): Understand how to retrieve category IDs for use in your API calls.
- [List articles](https://apidocs.neetokb.com/api/articles/list.md): This API allows to get a list of all articles.
- [Create article](https://apidocs.neetokb.com/api/articles/create.md): This API allows to create a new article.
- [Get article](https://apidocs.neetokb.com/api/articles/get.md): This API allows to fetch article details.
- [Update article](https://apidocs.neetokb.com/api/articles/update.md): This API allows to update an existing article.
- [Get unlisted link](https://apidocs.neetokb.com/api/articles/get-unlisted-link.md): This API allows to fetch the article's unlisted (secret) share link, creating a never-expiring one if none exists yet. An expired link is automatically replaced with a fresh one.
- [Regenerate unlisted link](https://apidocs.neetokb.com/api/articles/regenerate-unlisted-link.md): This API allows to generate a fresh unlisted link for the article, replacing any existing one. The previous URL stops working immediately.
- [Upload attachment](https://apidocs.neetokb.com/api/attachments/create.md): Upload a file (such as an image, PDF, or document) and get back a link you can use inside an article, so you don't have to embed the full file directly in the article's content, which makes articles large and slow to load. For images, the response also includes `attachable_html`: the image already f…
- [List authors](https://apidocs.neetokb.com/api/authors/list.md): This API allows to get a list of all authors.
- [List categories](https://apidocs.neetokb.com/api/categories/list.md): This API allows to get a list of all categories.
- [Get recommended articles](https://apidocs.neetokb.com/api/recommendations/get.md): This API returns recommended articles based on a specific URL or path.
- [Search articles](https://apidocs.neetokb.com/api/search/get.md): This API runs a full-text search across the workspace's published articles. Results are ranked by relevance, with the title weighted highest, then content, slug, category name, and keywords. Each match includes highlighted snippets showing where the search term appears.
- [Get organization settings](https://apidocs.neetokb.com/api/settings/get.md): This API allows to fetch organization settings.
- [List team members](https://apidocs.neetokb.com/api/team-members/list.md): List team members in the workspace.
- [Get team member details](https://apidocs.neetokb.com/api/team-members/get.md): Retrieves details of a specific team member.
- [Add team members](https://apidocs.neetokb.com/api/team-members/add.md): Add team members to the workspace.
- [Update team member](https://apidocs.neetokb.com/api/team-members/update.md): Update a team member.
- [Remove team member](https://apidocs.neetokb.com/api/team-members/remove.md): Remove a team member from the workspace.
- [List articles](https://apidocs.neetokb.com/api-reference-v1/articles/list.md): This API allows to get a list of all articles.
- [Create article](https://apidocs.neetokb.com/api-reference-v1/articles/create.md): This API allows to create a new article.
- [Get article](https://apidocs.neetokb.com/api-reference-v1/articles/get.md): This API allows to fetch article details.
- [Update article](https://apidocs.neetokb.com/api-reference-v1/articles/update.md): This API allows to update an existing article.
- [List authors](https://apidocs.neetokb.com/api-reference-v1/authors/list.md): This API allows to get a list of all authors.
- [List categories](https://apidocs.neetokb.com/api-reference-v1/categories/list.md): This API allows to get a list of all categories.
- [Get recommended articles](https://apidocs.neetokb.com/api-reference-v1/recommendations/get.md): This API returns recommended articles based on a specific URL or path.
- [Get organization settings](https://apidocs.neetokb.com/api-reference-v1/settings/get.md): This API allows to fetch organization settings.
- [List team members](https://apidocs.neetokb.com/api-reference-v1/team-members/list.md): List team members in the workspace.
- [Add team members](https://apidocs.neetokb.com/api-reference-v1/team-members/add.md): Add team members to the workspace.
- [Update team member details](https://apidocs.neetokb.com/api-reference-v1/team-members/update.md): Update a team member.
- [Remove team member](https://apidocs.neetokb.com/api-reference-v1/team-members/remove.md): Remove a team member from the workspace.
- [NeetoKB CLI](https://apidocs.neetokb.com/cli/introduction.md): Manage articles, categories, authors, and team members from your terminal.
- [Installation](https://apidocs.neetokb.com/cli/installation.md): Install the neetokb CLI on macOS, Linux, or Windows.
- [Workspace subdomain](https://apidocs.neetokb.com/cli/workspace-subdomain.md): Find your workspace subdomain and tell the CLI which workspace to use.
- [Authentication](https://apidocs.neetokb.com/cli/authentication.md): Sign in through the browser and manage credentials for one or more workspaces.
- [Output formats](https://apidocs.neetokb.com/cli/output-formats.md): Pretty tables, JSON, quiet, and TOON - and when to use each.
- [AI assistants](https://apidocs.neetokb.com/cli/ai-assistants.md): Set up NeetoKB for Claude, Cursor, Copilot, and other AI coding assistants.
- [Troubleshooting](https://apidocs.neetokb.com/cli/troubleshooting.md): Diagnose authentication and connectivity issues with neetokb doctor.
- [Commands overview](https://apidocs.neetokb.com/cli-reference/overview.md): Every neetokb command grouped by resource, with links to the full reference.
- [Articles](https://apidocs.neetokb.com/cli-reference/articles.md): List, search, view, create, update, and share articles.
- [Categories](https://apidocs.neetokb.com/cli-reference/categories.md): List the categories that organize your knowledge base.
- [Authors](https://apidocs.neetokb.com/cli-reference/authors.md): List the people who have written articles in your knowledge base.
- [Recommendations](https://apidocs.neetokb.com/cli-reference/recommendations.md): Fetch the articles NeetoKB recommends for a page or URL.
- [Team members](https://apidocs.neetokb.com/cli-reference/team-members.md): List, view, invite, update, and remove team members.
- [Workspace](https://apidocs.neetokb.com/cli-reference/workspace.md): View the settings of the knowledge base you are signed in to.
- [Utility commands](https://apidocs.neetokb.com/cli-reference/utility.md): Authentication, diagnostics, versioning, upgrades, AI-assistant setup, and shell completion.
- [NeetoKB MCP](https://apidocs.neetokb.com/mcp/introduction.md): Manage your NeetoKB knowledge base from an AI assistant in plain language.
- [Workspace subdomain](https://apidocs.neetokb.com/mcp/workspace-subdomain.md): Find your workspace subdomain and use it to connect an assistant.
- [Authentication](https://apidocs.neetokb.com/mcp/authentication.md): Connect as yourself with OAuth, or as the whole workspace with an API key.
- [MCP server](https://apidocs.neetokb.com/mcp/server.md): The NeetoKB MCP server endpoint, transport, and the sign-in options each agent supports.
- [Connect agent](https://apidocs.neetokb.com/mcp/connect.md): Step-by-step setup for Claude, ChatGPT, and other AI agents.
- [Examples](https://apidocs.neetokb.com/mcp/examples.md): Prompts to try once your assistant is connected to NeetoKB.
- [Troubleshooting](https://apidocs.neetokb.com/mcp/troubleshooting.md): What to check when an assistant cannot reach NeetoKB.
- [Tools](https://apidocs.neetokb.com/mcp/tools.md): Every tool the NeetoKB MCP server exposes, grouped by resource.

## OpenAPI Specs

- [articles](/bundled-v1/articles.yaml)
- [authors](/bundled-v1/authors.yaml)
- [categories](/bundled-v1/categories.yaml)
- [recommendations](/bundled-v1/recommendations.yaml)
- [settings](/bundled-v1/settings.yaml)
- [team-members](/bundled-v1/team-members.yaml)
- [articles](/bundled/articles.yaml)
- [attachments](/bundled/attachments.yaml)
- [authors](/bundled/authors.yaml)
- [categories](/bundled/categories.yaml)
- [recommendations](/bundled/recommendations.yaml)
- [search](/bundled/search.yaml)
- [settings](/bundled/settings.yaml)
- [team-members](/bundled/team-members.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.