# OnlyWorlds

> OnlyWorlds is an open schema for world data (22 element types with typed links), a hosted platform with a REST API v2 and an MCP server, and SDKs for TypeScript, Python and Unity.

Start with these pages (Markdown copies):

- [Getting started](https://onlyworlds.github.io/docs/getting-started.md): what OnlyWorlds is and a first call
- [Keys and PINs](https://onlyworlds.github.io/docs/getting-started/keys.md): which key and PIN a request needs
- [API overview](https://onlyworlds.github.io/docs/development/api-reference.md): base URL, headers, the error envelope
- [Reading](https://onlyworlds.github.io/docs/development/api/reads.md) · [Link fields](https://onlyworlds.github.io/docs/development/api/links.md) · [Writes and bulk](https://onlyworlds.github.io/docs/development/api/writes.md) · [Changes](https://onlyworlds.github.io/docs/development/api/changes.md)
- [Errors](https://onlyworlds.github.io/api/errors.md): every error code; each `doc_url` points here
- [Schema](https://onlyworlds.github.io/docs/schema.md) and [fields](https://onlyworlds.github.io/docs/schema/fields.md); one page per element type under /docs/schema/element_categories/
- [The LLM guide](https://onlyworlds.github.io/assets/ow_llm_guide.txt): the whole standard in one text file
- [OpenAPI document](https://www.onlyworlds.com/api/v2/openapi.json): the API, machine-readable

## Documentation Sets

- [Abridged documentation](https://onlyworlds.github.io/llms-small.txt): a compact version of the documentation for OnlyWorlds, with non-essential content removed
- [Complete documentation](https://onlyworlds.github.io/llms-full.txt): the full documentation for OnlyWorlds
- [API](https://onlyworlds.github.io/_llms-txt/api.txt): the REST API v2: reads, links, writes, changes, members, images, CORS, v1 migration and errors
- [Schema](https://onlyworlds.github.io/_llms-txt/schema.txt): the 22 element types, their fields and the conventions for using them
- [AI agents](https://onlyworlds.github.io/_llms-txt/ai-agents.txt): the MCP server, agent seats, the LLM guide and the toolkit

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation