Tools

You do not need these names to use the server. Ask in plain language and the assistant picks the right tool. The list is here for when you want to know exactly what a connection can do. Most tools match a REST API endpoint and link to its reference. Every tool takes an optional workspace argument, the subdomain of a connected workspace. Left out, it runs against the workspace the connection was set up with. ListWorkspaces reports the values you can pass. What a tool returns depends on the credential. Over OAuth, lists come back filtered to the permissions of the person who approved the connection, and a record they cannot open is refused rather than returned; an API key reaches the whole workspace. A tool that creates, updates, or deletes is also refused when the connection was not granted the Create and update or Delete permission.

Workspaces

Tool	What it does
`ListWorkspaces`	Lists the workspaces this connection can reach, with each one’s name and subdomain and which is the default. Pass a subdomain as the `workspace` argument of other tools to target that workspace.

ListWorkspaces has no REST endpoint, which is why it is not linked. An OAuth grant covers every workspace ticked on the Authorize access screen, which can be more than one. An API key covers the workspace it was generated in.

Articles

Tool	What it does
`SearchArticles`	Full-text search across published articles, ranked by relevance, returning each match with its id, title, absolute URLs and a highlighted snippet. Paginated.
`ListArticles`	Lists articles in the workspace, with optional filters for state (draft, published, archived or all), search term and category, plus sort order and pagination.
`GetArticle`	Returns one article in full, including its HTML content, plain text content, category, author, tags, related articles, internal note, schedules and URLs. Covers drafts and published articles alike.
`GetPublicArticle`	Reads one published article from any workspace by its subdomain and id, without workspace access. Returns only published articles in non-private categories, from workspaces that do not require sign-in.
`CreateArticle`	Creates an article under a category path given as an array of category names, innermost first, such as `["Getting Started", "Help"]`, auto-creating any missing categories, and can attach tags, related articles (`related_article_ids`) and an internal note (`note`). Defaults to a draft; a published article is readable on the public knowledge base site.
`UpdateArticle`	Updates an article’s title, HTML content, slug, state, category path (moving the article), tags, related articles or internal note. Publishing applies the changes to the live article and promotes any draft revision it was carrying.
`search`	Searches published articles and returns up to 20 matches, each with its id, title, an openable URL and a short extract.
`fetch`	Returns the full text of one published article by its id.
`ArchiveArticle`	Archives an article: it becomes a draft and is kept out of the public knowledge base.
`UnarchiveArticle`	Brings an archived article back as a draft.
`DiscardArticleDraft`	Throws away the unpublished draft changes of an article and keeps the live version. Refused for an article that is not published, because its draft is its only copy; trash that article instead.
`CloneArticle`	Copies an article into a new draft.
`BulkUpdateArticles`	Moves up to 100 articles to a category, sets their state, or archives or unarchives them. Give exactly one of `category_id`, `state` or `status`, or the call is refused. If one article cannot be updated, none are.
`BatchCreateArticles`	Create up to 25 articles in one all-or-nothing call, each with its own content.
`BatchUpdateArticles`	Update up to 25 articles in one all-or-nothing call, each with its own changes.

Article tools address an article by its slug, its permalink identifier (a-XXXXXXXX) or its UUID. GetPublicArticle also needs the workspace subdomain, and it never exposes drafts or the author’s email address. It has no page in the API reference, which is why it is not linked above.

search and fetch are the two tools the ChatGPT connector specification requires, so they overlap with SearchArticles and GetArticle rather than adding anything new. They have no separate REST endpoint, which is why they are not linked above.

Trash

Tool	What it does
`TrashArticle`	Moves one article to the trash.
`BulkTrashArticles`	Moves up to 100 articles to the trash. If one cannot be trashed, none are.
`ListTrashedArticles`	Lists the articles in the trash, with the days left before each is deleted for good. Paginated.
`RestoreArticle`	Moves an article out of the trash.
`DeleteTrashedArticle`	Deletes a trashed article for good.

DeleteTrashedArticle cannot be undone. Confirm the article before you approve the call.

Schedules

Tool	What it does
`ListArticleSchedules`	Lists the scheduled publish and unpublish actions of an article.
`ScheduleArticle`	Schedules an article to be published or unpublished at a future time, in a given time zone. An article holds at most one schedule of each kind, and when it has both, the unpublish time must not come after the publish time.
`DeleteArticleSchedule`	Deletes a scheduled action.

Article SEO

Tool	What it does
`GetArticleSeoSetting`	Returns the SEO settings of one article: title, title suffix, description, keywords and whether search engines may crawl it.
`UpdateArticleSeoSetting`	Changes those settings. Only the fields you pass change, and `keywords` replaces the whole list.

Revisions

Tool	What it does
`ListArticleRevisions`	Lists the revisions of an article, newest first. Paginated.
`GetArticleRevision`	Returns one revision with the title and HTML content it held.
`RestoreArticleRevision`	Copies a revision into the article’s draft. The live content does not change until the draft is published.

Attachments

Tool	What it does
`UploadAttachment`	Uploads a file from a public https `url` or from `content_base64` and returns its permanent `blob_url` and, for an image, its `attachable_html`, ready to paste into an article’s HTML content.

Unlisted links

Tool	What it does
`GetUnlistedLink`	Returns the unlisted share link an article already has. Only published articles can have one.
`RegenerateUnlistedLink`	Issues a fresh unlisted link for a published article, with an optional expiry, and is how an article gets its first link.

An unlisted link is an article’s secret share URL, which lets anyone holding it read the article without signing in. Treat the URL as sensitive.

RegenerateUnlistedLink replaces the token, so any previously shared URL stops working immediately. Confirm nobody still depends on the old link before you approve the call.

Tool	What it does
`GetCategory`	Returns one category by UUID or slug, with its parent, depth, privacy and article counts.
`CreateCategory`	Creates a category, optionally private, under a parent and at a position among its siblings.
`UpdateCategory`	Renames a category, changes its privacy, moves it to another parent or to the top level, or changes its position.
`DeleteCategory`	Deletes a category. Its articles and subcategories move to the category you name, or to the parent.
`ReorderCategoryArticles`	Sets the order of the articles in a category.
`ListCategories`	Lists every category the workspace holds, including private categories and categories that carry no articles yet, flattened depth first with each category’s parent, depth and published article counts.

Tool	What it does
`ListTags`	Lists tags with the number of articles each has. Can be searched and sorted. Paginated.
`CreateTag`	Creates a tag with an optional description and style.
`UpdateTag`	Changes a tag’s name, description or style.
`DeleteTag`	Deletes a tag and removes it from every article. The articles are kept.
`MergeTags`	Merges tags into a primary tag. The primary tag stays and the secondary tags are deleted.

Authors

Tool	What it does
`ListAuthors`	Lists the people credited on at least one article, deactivated members included, with each author’s name, email address, profile image and article counts. Can be sorted by count.

Recommendations

Tool	What it does
`ListRecommendations`	Lists the article recommendations configured for the workspace, each with a preview of the published articles it surfaces. Can be narrowed to the recommendations that match a page path.
`GetRecommendation`	Returns one recommendation with the articles and categories it points to.
`CreateRecommendation`	Creates a recommendation for pages whose URL matches, using `contains`, `exact_match` or `regex` matching.
`UpdateRecommendation`	Changes a recommendation. Passing `entities` replaces all of them.
`DeleteRecommendation`	Deletes a recommendation.

Redirections

Tool	What it does
`ListRedirections`	Lists redirections, newest first, with an optional search. Paginated.
`GetRedirection`	Returns one redirection.
`CreateRedirection`	Creates a page or domain redirection from an old path to a new path or URL.
`UpdateRedirection`	Changes a redirection.
`DeleteRedirection`	Deletes a redirection.

Tool	What it does
`ListNavigationLinks`	Lists the header and footer links of the public knowledge base in display order.
`UpdateNavigationLinks`	Replaces the header links, the footer links or both. Each set you pass becomes exactly that list.

Reports

Tool	What it does
`ListPopularSearches`	Lists the keywords visitors search for, with counts, for a period. Paginated.
`ListFailedSearches`	Lists the searches that found no article, with counts, for a period. Paginated.
`ListInvalidUrls`	Lists visited URLs that do not exist, with counts and referrers. Can be narrowed to one URL. Paginated.
`GetKbVisits`	Returns the visits to the knowledge base for each day of a period.
`ClearPopularSearches`	Deletes the popular searches data for a period, or all of it.
`ClearFailedSearches`	Deletes the failed searches data for a period, or all of it.
`ClearInvalidUrls`	Deletes the invalid URLs data for a period or URL, or all of it.

The report tools take duration, and start_date and end_date for a custom period. The Clear tools cannot be undone and return the number of rows deleted.

Team members

Tool	What it does
`ListTeamMembers`	Lists active team members with their id, email address, name, time zone and role. Can be narrowed to one exact email address.
`GetTeamMember`	Returns one active team member’s email address, name, time zone and role.
`CreateTeamMember`	Invites one or more people to the workspace by email, each assigned a role. An address that already belongs to the workspace is not invited again.
`UpdateTeamMember`	Updates a team member’s email address, name, time zone or role.
`DeleteTeamMember`	Deactivates a team member, ending their access. Their user record is kept so the articles they authored stay attributed to them.

The team member tools also check the connected person’s NeetoKB role: it must allow managing members, and changing a member’s role needs the manage-roles permission as well. These are role permissions inside NeetoKB, separate from the Create and update and Delete permissions ticked when approving the connection. An API key skips role checks.

Settings

Tool	What it does
`GetSetting`	Reads the knowledge base settings: its name and root URL, site content preference, sign-up, social sharing, article navigation links, header and search texts, copyright and contact section.
`UpdateSetting`	Changes those settings. Only the fields you pass change.
`GetSeoSetting`	Reads the SEO settings of the whole knowledge base.
`UpdateSeoSetting`	Changes the knowledge base SEO settings. `keywords` replaces the whole list.
`GetMyPreferences`	Reads the signed-in user’s preferences.
`UpdateMyPreferences`	Changes the signed-in user’s preferences, such as the monthly report email.
`UpdateNeetoChatIntegration`	Turns the NeetoChat integration on or off.

GetMyPreferences and UpdateMyPreferences need a signed-in user, so they are refused over an API key.

Themes

Tool	What it does
`ListThemes`	Lists built-in and custom themes. Paginated.
`GetTheme`	Returns one theme with its colors.
`UpdateTheme`	Renames a custom theme.
`DeleteTheme`	Deletes a custom theme. The published theme cannot be deleted.
`CloneTheme`	Copies a built-in or custom theme into a new unpublished custom theme.
`PublishTheme`	Makes a theme the one visitors see.
`GetThemeConfiguration`	Returns the fonts, colors, images and custom CSS of a theme.
`UpdateThemeConfiguration`	Changes the configuration of a custom theme. Colors are merged into the current ones.
`CreateThemeFont`	Adds a Google font to a custom theme.
`UpdateThemeFont`	Changes a font of a custom theme.
`DeleteThemeFont`	Removes a font from a custom theme.

Built-in themes cannot be changed. Clone one first.

Webhooks

Tool	What it does
`ListWebhooks`	Lists webhooks. The secret is never returned. Paginated.
`GetWebhook`	Returns one webhook.
`CreateWebhook`	Creates a webhook for an endpoint and a set of events.
`UpdateWebhook`	Changes a webhook. Passing `events` replaces the whole list.
`DeleteWebhook`	Deletes a webhook.
`ListWebhookEvents`	Lists the events a webhook can subscribe to.

Getting started

Reference

Workspaces

Articles

Trash

Schedules

Article SEO

Revisions

Attachments

Unlisted links

Categories

Tags

Authors

Recommendations

Redirections

Navigation links

Reports

Team members

Settings

Themes

Webhooks

​Workspaces

​Articles

​Trash

​Schedules

​Article SEO

​Revisions

​Attachments

​Unlisted links

​Categories

​Tags

​Authors

​Recommendations

​Redirections

​Navigation links

​Reports

​Team members

​Settings

​Themes

​Webhooks

Workspaces

Articles

Trash

Schedules

Article SEO

Revisions

Attachments

Unlisted links

Categories

Tags

Authors

Recommendations

Redirections

Navigation links

Reports

Team members

Settings

Themes

Webhooks