# Documentation

## Odyssey Docs

- [Welcome to Odyssey](https://docs.odyssey.stream/welcome-to-odyssey.md)
- [Getting Started](https://docs.odyssey.stream/upload-a-project/getting-started.md)
- [Set up your project](https://docs.odyssey.stream/upload-a-project/set-up-your-project.md)
- [Package for Linux (it's easy)](https://docs.odyssey.stream/upload-a-project/package-for-linux-its-easy.md)
- [Upload your project](https://docs.odyssey.stream/upload-a-project/upload-your-project.md)
- [Create and publish your space](https://docs.odyssey.stream/upload-a-project/create-and-publish-your-space.md)
- [Quickstart](https://docs.odyssey.stream/instant-multiplayer/quickstart.md): Instant Multiplayer overview and quickstart
- [Spatial voice & video](https://docs.odyssey.stream/instant-multiplayer/spatial-voice-and-video.md)
- [Add spatial comms to player](https://docs.odyssey.stream/instant-multiplayer/spatial-voice-and-video/add-spatial-comms-to-player.md)
- [Huddle](https://docs.odyssey.stream/instant-multiplayer/spatial-voice-and-video/huddle.md)
- [Share your screen](https://docs.odyssey.stream/instant-multiplayer/spatial-voice-and-video/share-your-screen.md)
- [Avatars](https://docs.odyssey.stream/instant-multiplayer/avatars.md)
- [Using Avatars](https://docs.odyssey.stream/instant-multiplayer/avatars/using-avatars.md)
- [Avatar Blueprints](https://docs.odyssey.stream/instant-multiplayer/avatars/avatar-blueprints.md)
- [Quickstart](https://docs.odyssey.stream/realtime-configurator/quickstart.md): Realtime Configurator overview and quickstart
- [Sketchfab importer](https://docs.odyssey.stream/realtime-configurator/sketchfab-importer.md)
- [Actor importer](https://docs.odyssey.stream/realtime-configurator/actor-importer.md)
- [Level & object configurator](https://docs.odyssey.stream/realtime-configurator/level-and-object-configurator.md)
- [Level configurator](https://docs.odyssey.stream/realtime-configurator/level-and-object-configurator/level-configurator.md)
- [Object configurator](https://docs.odyssey.stream/realtime-configurator/level-and-object-configurator/object-configurator.md)
- [Configurator blueprint API](https://docs.odyssey.stream/realtime-configurator/level-and-object-configurator/configurator-blueprint-api.md)
- [Media importer](https://docs.odyssey.stream/realtime-configurator/media-importer.md)
- [Vimeo & web panels](https://docs.odyssey.stream/realtime-configurator/media-importer/vimeo-and-web-panels.md)
- [Dolby.io in-world streams](https://docs.odyssey.stream/realtime-configurator/media-importer/dolby.io-in-world-streams.md)
- [Enable embedding](https://docs.odyssey.stream/embed-in-a-website/enable-embedding.md): Add Odyssey into your existing web stack as an iframe
- [Pass messages to and from Unreal](https://docs.odyssey.stream/embed-in-a-website/pass-messages-to-and-from-unreal.md)
- [Sending messages to Unreal](https://docs.odyssey.stream/embed-in-a-website/pass-messages-to-and-from-unreal/sending-messages-to-unreal.md)
- [Receiving messages from Unreal](https://docs.odyssey.stream/embed-in-a-website/pass-messages-to-and-from-unreal/receiving-messages-from-unreal.md)
- [Manage your stream](https://docs.odyssey.stream/embed-in-a-website/manage-your-stream.md)
- [Stream loading states](https://docs.odyssey.stream/embed-in-a-website/manage-your-stream/stream-loading-states.md)
- [Session states](https://docs.odyssey.stream/embed-in-a-website/manage-your-stream/session-states.md)
- [Stream quality settings](https://docs.odyssey.stream/embed-in-a-website/manage-your-stream/stream-quality-settings.md)
- [Dynamic styling](https://docs.odyssey.stream/embed-in-a-website/manage-your-stream/dynamic-styling.md)
- [Sharing and permissions](https://docs.odyssey.stream/admin/sharing-and-permissions.md)
- [Subscriptions](https://docs.odyssey.stream/admin/subscriptions.md)
- [Purchase stream hours](https://docs.odyssey.stream/admin/purchase-stream-hours.md)
- [Our GPUs (Coreweave)](https://docs.odyssey.stream/faq/our-gpus-coreweave.md)
- [Concurrent user limits](https://docs.odyssey.stream/faq/concurrent-user-limits.md)
- [Vulkan renderer](https://docs.odyssey.stream/faq/vulkan-renderer.md)
- [In-world video support on Linux](https://docs.odyssey.stream/faq/in-world-video-support-on-linux.md)
- [Add the Odyssey plugin](https://docs.odyssey.stream/guides/add-the-odyssey-plugin.md)
- [Validate your project settings](https://docs.odyssey.stream/guides/validate-your-project-settings.md)
- [Troubleshoot "Project zip is invalid"](https://docs.odyssey.stream/guides/troubleshoot-project-zip-is-invalid.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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.odyssey.stream/welcome-to-odyssey.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.
