--- title: "Get the details of a world" method: GET path: "/{worldId}/" tags: ["Worlds", "public"] --- # Get the details of a world `GET /{worldId}/` Retrieves and returns the specified world and linked launch context. ## Path parameters - `worldId` string, required ## Headers - `x-m2-organization-id` string, required — The ID of an organization - `x-m2-project-id` string, required — The ID of a project ## Response `200` The details for a world - GetWorldResponse — The details for a world - `documentId` string, required — The ID of a world - `name` string, required — The name of a world - `description` string — The description of a world - `pictureUrl` string, uri — The picture URL of a world - `transient` boolean, required — Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped. - `metadata` object — The metadata of a world. Includes annotations and labels used to customize the world deployments. - `annotations` object - `labels` object - `compute` object, required — Includes details relating to the compute resources that are relevant for deploying the world. - `group` union, required — The compute group of a world. Controls where the world will be deployed. - 'development' - 'testing' - 'staging' - 'production' - 'bare-metal' - string - `region` union, required — The compute region of a world. Controls which region the world will be deployed in. - 'Europe' - 'europe-west1' - 'europe-west2' - 'europe-west3' - 'europe-west4' - 'europe-north1' - `version` string — The compute version of a world. - `networking` object, required — The networking configuration of a world. - `strategy` 'Default', required - `scaling` object, required — The scaling configuration of a world. - `profile` union, required — The scaling profile of a world. This controls the overall capacity and configuration of a world. - 'Capacity30' - 'Tiny' - 'Capacity100' - 'Small' - 'Capacity500' - 'Medium' - 'Capacity1500' - 'Large5K' - 'Capacity5000' - 'Large' - 'Capacity15000' - 'Custom' - `configuration` unknown - `runtime` object, required - `build` object, required — The runtime build of a world. - `channelId` string, required — The ID of a build channel. - `tag` string, required — The tag of a build. - `content` object — The ID of a world builder content. - `id` string, required - `mapName` string, required — The name of the map the world will run. - `durationMinutes` number - `capacity` number — The maximum number of clients that this World can accept. Unbound if not set. - `admissionPolicy` union — The policy by which clients may connect to this runtime. Always allowed if not set. - 'Open' - 'Automatic' - 'Closed' - `status` object, required — The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information. - `phase` union, required — The current phase of the world. - 'Inactive' - 'Starting' - 'Active' - 'Stopping' - 'Error' - `message` string, required — Message providing human-readable information about the state of the world. - `startedAt` string — Provides information on when the world was last started. - `resolvedBuild` object — Information about the resolved build for the world once it was started. - `channelId` string, required — The ID of a build channel. - `tag` string, required — The tag of a build. - `organizationId` string, required - `id` string, required - `runId` string — The ID of a world - `manifest` object — The world manifest, describing server and client permissions. - `serverPermissions` string[], required - `clientPermissions` string[], required - `admission` object - `policy` union, required - 'Open' - 'Automatic' - 'Closed' - `capacity` number — The maximum number of clients that this World can accept. Unbound if not set. - `sessions` object - `controlPolicy` union - 'Unlimited' - 'ReplaceOlder' - `streamingTicketPredicate` string — If set, overrides the ticket predicate used to select a streaming slot - `flags` object - `ignoreExpiry` boolean, required — If set, allows expired sessions to be refreshed - `ignoreSlotRenewalErrors` boolean, required — If set, issues renewing a streaming slot will not invalidate the session - `ignoreParentMissing` boolean, required — If set, issues creating a child session if the parent is invalid - `useImmediateMode` boolean, required — If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity - `forceTravelWorldId` string — If set, causes Sessions belonging to this World to be force-travelled to the specified World ID. - `organizationId` string, required - `projectId` string, required - `launchContext` object — The shape of a launch context and extra details including the Organization and Project scope - `launchContextId` string, required - `name` string, required - `isActive` boolean, required — Defines whether the launch context is live - `publicDownload` object, nullable — Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it - `enabled` boolean, required — Whether public downloads are enabled. If `true`, all users are able to download the build provided they are using a compatible operating system. Windows is always supported, but MacOS support is optional and is determined by the `allowMac` field. - `enforceAntiCheat` boolean - `allowMac` boolean — Defines whether the build is compatible with MacOs - `allowIos` boolean — Defines whether the build is compatible with iOS - `isWorldTravelOnly` boolean - `worldId` string, required — The ID of a world - `description` string - `errorPageUrl` string — Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out - `okPageUrl` string — Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully - `gdnStreaming` object, nullable — Defines the necessary information to stream the event using GeForce Now - `cmsId` string, nullable - `authorizationId` string, nullable - `launchMode` union - 'same-tab' - 'same-tab-windowed' - 'tab' - 'tab-windowed' - 'embed' - 'embed-unsupported' - `ubitusStreaming` object, nullable — Defines the necessary information to stream the event using Ubitus - `gameLabel` string, required - `gameChannel` string, required - `streamManager` object, nullable — Defines the necessary information to stream the event using Stream Manager, our own service, which determines the best streaming provider to use based on different factors, such as a user's location - `streamContextId` string, required - `allowForceProvider` boolean - `showProviderOptions` boolean - `useBuildVersion` boolean - `bypassBrowserRestrictions` boolean — Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality. - `enableQueue` boolean - `capacity` number, nullable - `buildInfo` object, nullable - `buildChannelId` string, required - `buildTag` string, required - `buildType` union, required - 'client' - 'editor' - `splashScreenUrl` string - `useWorldSessions` boolean - `pictureUrl` string - `isPublic` boolean - `organizationId` string, required — The ID of an organization - `projectId` string, required — The ID of a project - `permissionVerb` union, required — The permission level that the user has over this resource. - '*' - 'r' - 'w' - 'g' - `queueState` object — Information about the number of active and queueing sessions for a world. - `queued` number, required - `active` number, required ## Other responses - `404` — The error object returned by the API when an error occurs --- [API](https://skmtc.net/otherside/apis/worlds.md) · [All operations](https://skmtc.net/otherside/apis/worlds/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/otherside/worlds/revisions/fe3e2eee3c6f/schema)