PageSourceSearch

https://vircadia.com/vircadia-world/server/service/api/

html vircadia.com collected 2026-10-03 20:17:54 UTC 30,421 bytes, 35 lines download raw bytes

1<!doctype html>
2<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-server/service/api/README" data-has-hydrated="false">
3<head>
4<meta charset="UTF-8">
5<meta name="generator" content="Docusaurus v3.7.0">
6<title data-rh="true">Vircadia World API | Vircadia</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://vircadia.com/img/og/vircadia_card.png"><meta data-rh="true" name="twitter:image" content="https://vircadia.com/img/og/vircadia_card.png"><meta data-rh="true" property="og:url" content="https://vircadia.com/vircadia-world/server/service/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Vircadia World API | Vircadia"><meta data-rh="true" name="description" content="The World API Manager is the interface between clients and the PostgreSQL database, and any other services that might be utilized."><meta data-rh="true" property="og:description" content="The World API Manager is the interface between clients and the PostgreSQL database, and any other services that might be utilized."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://vircadia.com/vircadia-world/server/service/api/"><link data-rh="true" rel="alternate" href="https://vircadia.com/vircadia-world/server/service/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://vircadia.com/vircadia-world/server/service/api/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Vircadia RSS Feed">
7<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Vircadia Atom Feed"><link rel="stylesheet" href="/assets/css/styles.845aae59.css">
8<script src="/assets/js/runtime~main.e8b9fc2c.js" defer="defer"></script>
vendor: 1 bytes, line 8
8
9<script src="/assets/js/main.bb212bba.js" defer="defer"></script>
9
10</head>
11<body class="navigation-with-keyboard">
12<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script>
12<div id="__docusaurus"><link rel="preload" as="image" href="/img/icon.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Need help integrating Vircadia? <a href="/cdn-cgi/l/email-protection#472f222b2b2807312e352426232e266924282a">Get in touch!</a></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/icon.svg" alt="Vircadia Icon" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/icon.svg" alt="Vircadia Icon" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Vircadia</b></a></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/vircadia-world/">Docs</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/vircadia-world/">Get Started</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Case Studies</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/stories/vircadia-x-lpi">Linux Professional Institute</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/vircadia-world/">Get started</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/vircadia-world/cli/">CLI</a><button aria-label="Expand sidebar category &#x27;CLI&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/vircadia-world/client/web_babylon_
12js/">Client</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/vircadia-world/sdk/vircadia-world-sdk-ts/">SDK</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/vircadia-world/server/">Server</a><button aria-label="Collapse sidebar category &#x27;Server&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" tabindex="0" href="/vircadia-world/server/service/">Services</a><button aria-label="Collapse sidebar category &#x27;Services&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/vircadia-world/server/service/api/">World API Manager</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/vircadia-world/server/service/pgweb/">PGWeb</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/vircadia-world/server/service/postgresql/">PostgreSQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/vircadia-world/server/service/state/">World State Manager</a></li></ul></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/vircadia-world/server/"><span itemprop="name">Server</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/vircadia-world/server/service/"><span itemprop="name">Services</span></a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">World API Manager</span><meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Vircadia World API</h1></header>
13<p>The World API Manager is the interface between clients and the PostgreSQL database, and any other services that might be utilized.</p>
14<h2 class="anchor anchorWithStickyNavbar_LWe7" id="rest-api">
14REST API<a href="#rest-api" class="hash-link" aria-label="Direct link to REST API" title="Direct link to REST API">​</a></h2>
15<p>The REST API is accessible at the base path:</p>
16<pre>/world/rest</pre>
17<h3 class="anchor anchorWithStickyNavbar_LWe7" id="available-endpoints">Available Endpoints<a href="#available-endpoints" class="hash-link" aria-label="Direct link to Available Endpoints" title="Direct link to Available Endpoints">​</a></h3>
18<table><thead><tr><th>Endpoint</th><th>Method</th><th>Path</th><th>Description</th></tr></thead><tbody><tr><td><code>AUTH_SESSION_VALIDATE</code></td><td><code>POST</code></td><td><code>/world/rest/session/validate</code></td><td>Validates a user session token from an authentication provider</td></tr><tr><td colspan="4"><details><summary>Parameters</summary><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><code>token</code></td><td><code>string</code></td><td>Yes</td><td>Authentication token to validate</td></tr><tr><td><code>provider</code></td><td><code>string</code></td><td>Yes</td><td>Name of the authentication provider (e.g., &#x27;oauth&#x27;, &#x27;local&#x27;)</td></tr></tbody></table></details></td></tr><tr><td colspan="4"><details><summary>Returns</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Response indicating whether the session is valid</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>success</code></td><td><code>boolean</code></td><td>Indicates if the validation was successful</td></tr><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the response was generated</td></tr><tr><td><code>error</code></td><td><code>string</code></td><td>Error message (only present when success is false)</td></tr></tbody></table></details></td></tr></tbody></table>
19<h2 class="anchor anchorWithStickyNavbar_LWe7" id="websocket-api">WebSocket API<a href="#websocket-api" class="hash-link" aria-label="Direct link to WebSocket API" title="Direct link to WebSocket API">​</a></h2>
20<p>WebSocket connections are established by upgrading a connection at:</p>
21<pre>/world/ws</pre>
22<h3 class="anchor anchorWithStickyNavbar_LWe7" id="establish-connection">Establish Connection<a href="#establish-connection" class="hash-link" aria-label="Direct link to Establish Connection" title="Direct link to Establish Connection">​</a></h3>
23<p>The WebSocket connection is established by creating a connection with search parameters:</p>
24<div class="language-typescript codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_Ktv7">TypeScript WS upgrade example</div><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-typescript codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Format for WebSocket connection URL</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> url </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> </span><span class="token class-name constant" style="color:#36acaa">URL</span><span class="token punctuation" style="color:#393A34">(</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token template-string string" style="color:#e3116c">https://server-domain</span><span class="token template-string interpolation interpolation-punctuation punctuation" style="color:#393A34">${</span><span class="token template-string interpolation">Communication</span><span class="token template-string interpolation punctuation" style="color:#393A34">.</span><span class="token template-string interpolation constant" style="color:#36acaa">WS_UPGRADE_PATH</span><span class="token template-string interpolation interpolation-punctuation punctuation" style="color:#393A34">}</span><span class="token template-string template-punctuation string" style="color:#e3116c">`</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">url</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">searchParams</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;token&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> authToken</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain">    </span><span class="token comment" style="color:#999988;font-style:italic">// Authentication token</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">url</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">searchParams</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&quot;provider&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> authProvider</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain">  </span><span class="token comment" style="color:#999988;font-style:italic">// Authentication provider name</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> ws </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> </span><span class="token class-name">WebSocket</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">url</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N">
24<path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
25<p>Required URL parameters:</p>
26<ul>
27<li><code>token</code>: Authentication token obtained from the authentication provider</li>
28<li><code>provider</code>: Name of the authentication provider (e.g., &#x27;system&#x27;, &#x27;local&#x27;)</li>
29</ul>
30<h3 class="anchor anchorWithStickyNavbar_LWe7" id="message-types">Message Types<a href="#message-types" class="hash-link" aria-label="Direct link to Message Types" title="Direct link to Message Types">​</a></h3>
31<p>The following message types are available in the WebSocket API:</p>
32<table><thead><tr><th>Message Type</th><th>Description</th></tr></thead><tbody><tr><td><code>GENERAL_ERROR_RESPONSE</code></td><td>Response sent when a general error occurs during processing</td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Error response with details about the failure</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the error occurred</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>ID of the request that generated the error</td></tr><tr><td><code>errorMessage</code></td><td><code>string</code></td><td>Detailed error message describing what went wrong</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (GENERAL_ERROR_RESPONSE)</td></tr></tbody></table></details></td></tr><tr><td><code>QUERY_REQUEST</code></td><td>Request to execute a query on the server</td></tr><tr><td colspan="2"><details><summary>Parameters</summary><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><code>query</code></td><td><code>string</code></td><td>Yes</td><td>The query string to execute</td></tr><tr><td><code>parameters</code></td><td><code>array</code></td><td>No</td><td>Array of parameters to pass to the query</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>Yes</td><td>Unique identifier for this request</td></tr></tbody></table></details></td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Query request object</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the request was created</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>Unique identifier for this request</td></tr><tr><td><code>errorMessage</code></td><td><code>string | null</code></td><td>Error message if there was an issue with the request format</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (QUERY_REQUEST)</td></tr><tr><td><code>query</code></td><td><code>string</code></td><td>The query string to execute</td></tr><tr><td><code>parameters</code></td><td><code>array</code></td><td>Array of parameters to pass to the query</td></tr></tbody></table></details></td></tr><tr><td><code>QUERY_RESPONSE</code></td><td>Response to a query request with results or error information</td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Query response containing results or error details</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the response was generated</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>ID of the request this response is for</td></tr><tr><td><code>errorMessage</code></td><td><code>string | null</code></td><td>Error message if the query failed, null if successful</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (QUERY_RESPONSE)</td></tr><tr><td><code>result</code></td><td><code>T | []</code></td><td>Query results, empty array if no results or error</td></tr></tbody></table></details></td></tr><tr><td><code>SYNC_GROUP_UPDATES_RESPONSE</code></td><td>Response containing updates for a sync group</td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Updates for entities in a specific sync group</p><h4>Fields</h4><table><thead><tr><th>
32Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the updates were generated</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>ID of the request that triggered these updates</td></tr><tr><td><code>errorMessage</code></td><td><code>string | null</code></td><td>Error message if there was a problem, null if successful</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (SYNC_GROUP_UPDATES_RESPONSE)</td></tr></tbody></table></details></td></tr><tr><td><code>TICK_NOTIFICATION_RESPONSE</code></td><td>Notification sent when a server tick occurs</td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Information about the completed tick</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the tick notification was sent</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>ID for this notification</td></tr><tr><td><code>errorMessage</code></td><td><code>string | null</code></td><td>Error message if there was an issue, null if successful</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (TICK_NOTIFICATION_RESPONSE)</td></tr><tr><td><code>tick</code></td><td><code>Tick.I_Tick</code></td><td>Detailed information about the tick that completed</td></tr></tbody></table></details></td></tr><tr><td><code>SESSION_INFO_RESPONSE</code></td><td>Session info sent to client on connection establishment</td></tr><tr><td colspan="2"><details><summary>Message Format</summary><p><strong>Type:</strong> <code>object</code></p><p><strong>Description:</strong> <!-- -->Information about the session assigned by the server</p><h4>Fields</h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Unix timestamp when the session info was sent</td></tr><tr><td><code>requestId</code></td><td><code>string</code></td><td>Empty string for session info messages</td></tr><tr><td><code>errorMessage</code></td><td><code>string | null</code></td><td>Error message, null for session info messages</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>Message type identifier (SESSION_INFO_RESPONSE)</td></tr><tr><td><code>agentId</code></td><td><code>string</code></td><td>The agent identifier assigned by the server</td></tr><tr><td><code>sessionId</code></td><td><code>string</code></td><td>The session identifier assigned by the server</td></tr></tbody></table></details></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/Vircadia/vircadia-world/edit/master/server/service/api/README.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/vircadia-world/server/service/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/vircadia-world/server/service/pgweb/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">PGWeb</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#rest-api" class="table-of-contents__link toc-highlight">REST API</a><ul><li><a href="#available-endpoints" class="table-of-contents__link toc-highlight">Available Endpoints</a></li></ul></li><li><a href="#websocket-api" class="table-of-contents__link toc-highlight">WebSocket API</a><ul><li><a href="#establish-connection" class="table-of-contents__link toc-highlight">Establish Connection</a></li><li><a href="#message-types" class="table-of-contents__link toc-highlight">Message Types</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center">
32<div class="footer__copyright">Copyright © 2026 Vircadia</div></div></div></footer></div>
vendor: 109 bytes, lines 32-33
32
33<script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script>
33<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v31edd6df95cf4e85bb4c19e7a9bdbcba1788362987495" integrity="sha512-iIg7k2xntmwu6/uSb5tpc/hySgZc4eoL31yB29W6tJFo2akwjPWcEqnCEdJvGexCL0KEQwVYv5BlowfhVz26hg==" data-cf-beacon='{"version":"2024.11.0","token":"f30334e86a2a4c47a97c69cb8b47df91","r":1,"spa":2}' crossorigin="anonymous"></script>
33
34</body>
35</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.