> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# XWiki API

> Search and read your XWiki, check what is already documented, and draft new pages from tickets

The common use is documentation: an agent searches the MSP's own wiki for the procedure a ticket needs, reads the pages it finds, and answers from them. After a ticket is solved, it checks whether the fix is documented and drafts a new page when it is not.

> [!NOTE]
>
> Automatically enabled when you configure XWiki permissions in your agent workflow, or on a dashboard.

## What It Does

* Search the wiki by title and content, and read each page in full, in any nested space
* Read page history, versions, translations, tags, comments and attached text files
* Create new pages, such as a draft built from a ticket, after a read shows no page has that name
* With Page Changes, change an existing page's content after checking it is still at the version it read, change its translations and tags, or delete it
* Add comments and annotations, upload text files, and read and change structured data (objects and Live Data)
* Read users, the account's notifications and page watches, and the status of server jobs

## Permission Groups

| Group | Covers |
| - | - |
| Pages | Search the wiki and read pages with their content, title, children, tags and translations; wikis, spaces and queries. Write creates new pages only: Neo refuses a page that already exists |
| Page Changes | Page history, versions, recent changes and required rights. Write changes or deletes existing pages, their translations, tags and pinned pages |
| Comments & Annotations | Comments and annotations on pages. Add comments, and add, change and delete annotations |
| Attachments | Files attached to pages, their versions and metadata. Upload a text file to a page, and delete attachments |
| Objects & Classes | Structured data on pages (objects and their properties), classes and Live Data tables. Create, change and delete objects and Live Data entries |
| Users & Notifications | Users, the account Neo signs in with, its notifications and page watches, and the status and log of server jobs. Watch or stop watching pages, and change the account's own preferences |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | New pages and comments; Page Changes stays Read Only |
| **IT Admin** | Every read, and changes to pages, comments and attachments | Structured data and the account's own settings |
| **Full Automation** | Every read and write | Only the writes in Safety Controls |

## Safety Controls

| Control | Behavior |
| - | - |
| **Writes check first** | Before a create, Neo reads the page and sends nothing when it exists. Changing an existing page needs the Page Changes group. Just before it sends new content for a page, Neo checks that the page is still at the version it read; a translation, a tag change or a delete goes without that check. XWiki has no write that makes either check part of the save, so a page another writer creates or changes between Neo's check and its write is replaced; Neo reports a replaced create, and the page history keeps every earlier version |
| **Access always asks** | A change to rights, users or groups, to a page's required rights, and every Live Data write ask a technician first, in every profile |
| **Wrong password caught** | XWiki answers a wrong password on a read as an anonymous visitor with empty results. Neo detects it and stops, so an empty search never reads as "not documented" |
| **Never sent** | Server jobs (an extension install runs code on the wiki server) and XAR imports, which replace pages in bulk |
| **Your rights apply** | Neo signs in as the account you saved, so XWiki refuses anything that account may not do, such as a write outside its space |


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