> For the complete documentation index, see [llms.txt](https://docs.yjs.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yjs.dev/api.md).

# API

- [Y.Doc](https://docs.yjs.dev/api/y.doc.md)
- [Shared Types](https://docs.yjs.dev/api/shared-types.md)
- [Y.Map](https://docs.yjs.dev/api/shared-types/y.map.md): A shared type with a similar API to global.Map
- [Y.Array](https://docs.yjs.dev/api/shared-types/y.array.md): A shared type to store data in a sequence-like data structure
- [Y.Text](https://docs.yjs.dev/api/shared-types/y.text.md): A shared type that represents Text & RichText
- [Y.XmlFragment](https://docs.yjs.dev/api/shared-types/y.xmlfragment.md): A shared type to manage a collection of Y.Xml\* Nodes
- [Y.XmlElement](https://docs.yjs.dev/api/shared-types/y.xmlelement.md): A shared type that represents an XML node
- [Y.XmlText](https://docs.yjs.dev/api/shared-types/y.xmltext.md): Extends Y.Text to represent a Y.Xml node.
- [Y.UndoManager](https://docs.yjs.dev/api/undo-manager.md): A selective Undo/Redo manager for Yjs.
- [Y.Event](https://docs.yjs.dev/api/y.event.md)
- [Delta Format](https://docs.yjs.dev/api/delta-format.md)
- [Document Updates](https://docs.yjs.dev/api/document-updates.md): How to sync documents with other peers.
- [Y.RelativePosition](https://docs.yjs.dev/api/relative-positions.md): A powerful position encoding that transforms back to index positions
- [Awareness](https://docs.yjs.dev/api/about-awareness.md): API documentation of the Awareness CRDT
- [Subdocuments](https://docs.yjs.dev/api/subdocuments.md): Embedding Yjs documents into Yjs documents
- [Internals](https://docs.yjs.dev/api/internals.md): Implementation Details - The inner working of Yjs
- [FAQ](https://docs.yjs.dev/api/faq.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.yjs.dev/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.