v1

latestOpenAPI 3.0.42026-07-23366.9 KB
rooms

Creates a room instance on the server.

post/add

Request body

UniqueIDinteger required

Unique ID of the room instance. This ID is used to identify the room in the server.

Secretstring required

Secret used for authenticating Simulator connections.

MaxClientsinteger required

Maximum number of clients allowed to connect to the room instance.

MaxEntitiesinteger required

Maximum number of entities allowed to be created in the room instance.

MaxQueriesPerClientinteger required

Maximum number of queries that each client can have active at any time.

SchemaNamestring

Name of the schema to be used for the room instance.

SchemaTimeoutinteger

How long (in seconds) the schema should be cached in the server before being removed.

SchemaUrlsstring[]

URLs of the schemas to be used for the room instance.

Schemasstring[]

List of schemas to be used for the room instance.

DisconnectTimeoutinteger required

How long (in milliseconds) the server should wait before closing the connection to a client that hasn't sent any data.

DebugStreamsboolean

Whether to enable debug streams for the room instance.

SendFrequencyinteger required

Frequency (Hz) at which the server should send updates to clients.

RecvFrequencyinteger required

Frequency (Hz) at which the server expects to receive updates from clients.

MinQueryDistancenumber float

Minimum displacement distance for a query to be considered changed.

CleanupTimeoutinteger required

How long (in seconds) the server should wait before removing a room instance that has no active clients.

ProjectIDstring required

ID of the project to which the room instance belongs.

KVPobject

Key-Value Pair (KVP) data associated with the room instance.

PrivateKVPobject

Private Key-Value Pair (KVP) data associated with the room instance.

Tagsstring[]

Tags associated with the room instance.

Createdstring date-time

Timestamp indicating when the room instance was created.

HostAuthoritystring

Comma-separated list of host authority features. Valid values are "create-entities" and "validate-connection". Example "create-entities,validate-connection"

Response

Room was created successfully

RoomIDinteger required

ID of the room instance as assigned by the server.

Secretstring required