--- title: "Create a world" method: POST path: "/" tags: ["Worlds", "public"] --- # Create a world `POST /` Creates a world in the given Organization and Project. Checks if the user can create a world with the given size. ## Headers - `x-m2-organization-id` string, required — The ID of an organization - `x-m2-project-id` string, required — The ID of a project ## Request body - PostWorldRequest — The new world's details - `streaming` object — The streaming configuration for a world - `gdn` object, nullable, required — 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' - `streamManager` object, nullable, required — 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 - `ubitus` object, nullable, required — Defines the necessary information to stream the event using Ubitus - `gameLabel` string, required - `gameChannel` string, required - `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. - `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 - `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 - `compute` object — Includes details relating to the compute resources that are relevant for deploying the world. - `group` union — The compute group of a world. Controls where the world will be deployed. - 'development' - 'testing' - 'staging' - 'production' - 'bare-metal' - string - `region` union — 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 — The networking configuration of a world. - `strategy` 'Default' - `scaling` object — 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 - `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' - `build` union, required — The runtime build of a world. A build can be specified by a channel and tag, or by a content ID. - object - `channelId` string, required — The ID of a build channel. - `tag` string, required — The tag of a build. - `content` object - `id` string, required - object - `channelId` string — The ID of a build channel. - `tag` string — The tag of a build. - `content` object, required — The ID of a world builder content. - `id` string, required - `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 - `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. ## Response `200` The world's ID, if created successfully - PostWorldResponse — The world's ID, if created successfully - `worldId` string, required — The ID of a world - `launchContextId` string, required — The ID of a launch context --- [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)