{"openapi":"3.1.0","info":{"title":"Worlds","description":"The Worlds service manages virtual environments, each defined by World Builder content with custom runtime settings (map selection, session duration, etc.).","version":"0.1.0"},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"HttpError":{"type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"}}},"apiError":{"description":"The error object returned by the API when an error occurs","type":"object","properties":{"error":{"description":"HTTP error message","type":"string"},"code":{"description":"Fastify error code","type":"string"},"message":{"description":"User error message","type":"string"},"statusCode":{"description":"HTTP status code","type":"number"}},"required":["error","message","statusCode"]},"httpError":{"description":"HTTP error message","type":"string"},"errorCode":{"description":"Fastify error code","type":"string"},"errorMessage":{"description":"User error message","type":"string"},"errorStatusCode":{"description":"HTTP status code","type":"number"},"statusMessage":{"description":"Provides information about the service status.","type":"string"},"worldHeaders":{"description":"The headers that define which organization and project to retrieve worlds from for the world endpoint","type":"object","properties":{"x-m2-organization-id":{"$ref":"#/components/schemas/organizationId"},"x-m2-project-id":{"$ref":"#/components/schemas/projectId"}},"required":["x-m2-organization-id","x-m2-project-id"]},"worldParams":{"description":"The ID of the world for world endpoints","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"}},"required":["worldId"]},"getWorldResponse":{"description":"The details for a world","type":"object","properties":{"documentId":{"description":"The ID of a world","type":"string"},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"transient":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"required":["group","region"]},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}},"required":["strategy","scaling"]},"runtime":{"type":"object","properties":{"build":{"description":"The runtime build of a world.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},"mapName":{"pattern":"^\\S.*\\S$|^\\S$","description":"The name of the map the world will run.","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"},"admissionPolicy":{"description":"The policy by which clients may connect to this runtime. Always allowed if not set.","anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]}},"required":["build","mapName"]},"status":{"description":"The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.","type":"object","properties":{"phase":{"description":"The current phase of the world.","anyOf":[{"type":"string","enum":["Inactive"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Stopping"]},{"type":"string","enum":["Error"]}]},"message":{"description":"Message providing human-readable information about the state of the world.","type":"string"},"startedAt":{"description":"Provides information on when the world was last started.","type":"string"},"resolvedBuild":{"description":"Information about the resolved build for the world once it was started.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"organizationId":{"type":"string"},"id":{"type":"string"}},"required":["channelId","tag","organizationId","id"]},"runId":{"description":"The ID of a world","type":"string"}},"required":["phase","message"]},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"sessions":{"type":"object","properties":{"controlPolicy":{"anyOf":[{"type":"string","enum":["Unlimited"]},{"type":"string","enum":["ReplaceOlder"]}]},"streamingTicketPredicate":{"description":"If set, overrides the ticket predicate used to select a streaming slot","type":"string"},"flags":{"type":"object","properties":{"ignoreExpiry":{"default":false,"description":"If set, allows expired sessions to be refreshed","type":"boolean"},"ignoreSlotRenewalErrors":{"default":false,"description":"If set, issues renewing a streaming slot will not invalidate the session","type":"boolean"},"ignoreParentMissing":{"default":false,"description":"If set, issues creating a child session if the parent is invalid","type":"boolean"},"useImmediateMode":{"default":false,"description":"If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity","type":"boolean"}},"required":["ignoreExpiry","ignoreSlotRenewalErrors","ignoreParentMissing","useImmediateMode"]},"forceTravelWorldId":{"description":"If set, causes Sessions belonging to this World to be force-travelled to the specified World ID.","type":"string"}}},"organizationId":{"type":"string"},"projectId":{"type":"string"},"launchContext":{"description":"The shape of a launch context and extra details including the Organization and Project scope","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isWorldTravelOnly":{"type":"boolean"},"worldId":{"allOf":[{"type":"string"},{"description":"The ID of a world","type":"string"}]},"description":{"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"splashScreenUrl":{"type":"string"},"useWorldSessions":{"type":"boolean"},"pictureUrl":{"allOf":[{"type":"string"},{"type":"string"}]},"isPublic":{"type":"boolean"},"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"permissionVerb":{"description":"The permission level that the user has over this resource.","anyOf":[{"type":"string","enum":["*"]},{"type":"string","enum":["r"]},{"type":"string","enum":["w"]},{"type":"string","enum":["g"]}]}},"required":["launchContextId","name","isActive","worldId","organizationId","projectId","permissionVerb"]},"queueState":{"description":"Information about the number of active and queueing sessions for a world.","type":"object","properties":{"queued":{"type":"number"},"active":{"type":"number"}},"required":["queued","active"]}},"required":["documentId","name","transient","compute","networking","runtime","status","organizationId","projectId"]},"worldName":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"worldDescription":{"maxLength":256,"description":"The description of a world","type":"string"},"worldPictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"worldTransientState":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"worldMetadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"worldComputeGroup":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"worldComputeRegion":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"worldComputeVersion":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"},"worldScalingProfile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"runId":{"description":"The ID of a world","type":"string"},"extendedLaunchContext":{"description":"The shape of a launch context and extra details including the Organization and Project scope","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isWorldTravelOnly":{"type":"boolean"},"worldId":{"allOf":[{"type":"string"},{"description":"The ID of a world","type":"string"}]},"description":{"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"splashScreenUrl":{"type":"string"},"useWorldSessions":{"type":"boolean"},"pictureUrl":{"allOf":[{"type":"string"},{"type":"string"}]},"isPublic":{"type":"boolean"},"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"permissionVerb":{"description":"The permission level that the user has over this resource.","anyOf":[{"type":"string","enum":["*"]},{"type":"string","enum":["r"]},{"type":"string","enum":["w"]},{"type":"string","enum":["g"]}]}},"required":["launchContextId","name","isActive","worldId","organizationId","projectId","permissionVerb"]},"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"WorldSessionsQueueState":{"description":"Information about the number of active and queueing sessions for a world.","type":"object","properties":{"queued":{"type":"number"},"active":{"type":"number"}},"required":["queued","active"]},"postWorldRequest":{"description":"The new world's details","type":"object","properties":{"streaming":{"description":"The streaming configuration for a world","type":"object","properties":{"gdn":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"ubitus":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"}},"required":["gdn","streamManager","ubitus"]},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"default":{}},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}}},"runtime":{"type":"object","properties":{"mapName":{"pattern":"^\\S.*\\S$|^\\S$","description":"The name of the map the world will run.","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"},"admissionPolicy":{"description":"The policy by which clients may connect to this runtime. Always allowed if not set.","anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"build":{"description":"The runtime build of a world. A build can be specified by a channel and tag, or by a content ID.","anyOf":[{"type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},{"type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["content"]}]}},"required":["mapName","build"]},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"transient":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"sessions":{"type":"object","properties":{"controlPolicy":{"anyOf":[{"type":"string","enum":["Unlimited"]},{"type":"string","enum":["ReplaceOlder"]}]},"streamingTicketPredicate":{"description":"If set, overrides the ticket predicate used to select a streaming slot","type":"string"},"flags":{"type":"object","properties":{"ignoreExpiry":{"default":false,"description":"If set, allows expired sessions to be refreshed","type":"boolean"},"ignoreSlotRenewalErrors":{"default":false,"description":"If set, issues renewing a streaming slot will not invalidate the session","type":"boolean"},"ignoreParentMissing":{"default":false,"description":"If set, issues creating a child session if the parent is invalid","type":"boolean"},"useImmediateMode":{"default":false,"description":"If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity","type":"boolean"}},"required":["ignoreExpiry","ignoreSlotRenewalErrors","ignoreParentMissing","useImmediateMode"]},"forceTravelWorldId":{"description":"If set, causes Sessions belonging to this World to be force-travelled to the specified World ID.","type":"string"}}}},"required":["runtime","name","transient"]},"WorldStreaming":{"description":"The streaming configuration for a world","type":"object","properties":{"gdn":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"ubitus":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"}},"required":["gdn","streamManager","ubitus"]},"postWorldResponse":{"description":"The world's ID, if created successfully","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"},"launchContextId":{"description":"The ID of a launch context","type":"string"}},"required":["worldId","launchContextId"]},"launchContextId":{"description":"The ID of a launch context","type":"string"},"patchWorldRequest":{"description":"The world details to update. Partial updates of object fields are not allowed. All nested fields must be provided and optional fields will be reset to default.","type":"object","properties":{"streaming":{"description":"The streaming configuration for a world","type":"object","properties":{"gdn":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"ubitus":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"}},"required":["gdn","streamManager","ubitus"]},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isPublic":{"type":"boolean"},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","type":"string"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"required":["group","region"]},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}},"required":["strategy","scaling"]},"runtime":{"type":"object","properties":{"build":{"description":"The world runtime build fields that can be updated.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}}},"mapName":{"pattern":"^\\S.*\\S$|^\\S$","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"type":"number"},"admissionPolicy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]}},"description":"The world runtime fields that can be updated."},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]}}},"patchWorldResponse":{"description":"The updated world details","type":"object","properties":{"documentId":{"description":"The ID of a world","type":"string"},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"transient":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"required":["group","region"]},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}},"required":["strategy","scaling"]},"runtime":{"type":"object","properties":{"build":{"description":"The runtime build of a world.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},"mapName":{"pattern":"^\\S.*\\S$|^\\S$","description":"The name of the map the world will run.","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"},"admissionPolicy":{"description":"The policy by which clients may connect to this runtime. Always allowed if not set.","anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]}},"required":["build","mapName"]},"status":{"description":"The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.","type":"object","properties":{"phase":{"description":"The current phase of the world.","anyOf":[{"type":"string","enum":["Inactive"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Stopping"]},{"type":"string","enum":["Error"]}]},"message":{"description":"Message providing human-readable information about the state of the world.","type":"string"},"startedAt":{"description":"Provides information on when the world was last started.","type":"string"},"resolvedBuild":{"description":"Information about the resolved build for the world once it was started.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"organizationId":{"type":"string"},"id":{"type":"string"}},"required":["channelId","tag","organizationId","id"]},"runId":{"description":"The ID of a world","type":"string"}},"required":["phase","message"]},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"sessions":{"type":"object","properties":{"controlPolicy":{"anyOf":[{"type":"string","enum":["Unlimited"]},{"type":"string","enum":["ReplaceOlder"]}]},"streamingTicketPredicate":{"description":"If set, overrides the ticket predicate used to select a streaming slot","type":"string"},"flags":{"type":"object","properties":{"ignoreExpiry":{"default":false,"description":"If set, allows expired sessions to be refreshed","type":"boolean"},"ignoreSlotRenewalErrors":{"default":false,"description":"If set, issues renewing a streaming slot will not invalidate the session","type":"boolean"},"ignoreParentMissing":{"default":false,"description":"If set, issues creating a child session if the parent is invalid","type":"boolean"},"useImmediateMode":{"default":false,"description":"If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity","type":"boolean"}},"required":["ignoreExpiry","ignoreSlotRenewalErrors","ignoreParentMissing","useImmediateMode"]},"forceTravelWorldId":{"description":"If set, causes Sessions belonging to this World to be force-travelled to the specified World ID.","type":"string"}}},"launchContext":{"description":"The shape of a launch context","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isWorldTravelOnly":{"type":"boolean"},"worldId":{"type":"string"},"description":{"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"splashScreenUrl":{"type":"string"},"useWorldSessions":{"type":"boolean"},"pictureUrl":{"type":"string"},"isPublic":{"type":"boolean"}},"required":["launchContextId","name","isActive","worldId"]}},"required":["documentId","name","transient","compute","networking","runtime","status"]},"launchContext":{"description":"The shape of a launch context","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isWorldTravelOnly":{"type":"boolean"},"worldId":{"type":"string"},"description":{"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"splashScreenUrl":{"type":"string"},"useWorldSessions":{"type":"boolean"},"pictureUrl":{"type":"string"},"isPublic":{"type":"boolean"}},"required":["launchContextId","name","isActive","worldId"]},"deleteWorldResponse":{"description":"Empty response","not":{}},"startWorldResponse":{"description":"Empty response","not":{}},"stopWorldResponse":{"description":"Empty response","not":{}},"connectWorldRequest":{"description":"The parameters to use when generating connection details for a world","type":"object","properties":{"tokenFormat":{"description":"The format of the Morpheus access token.","anyOf":[{"type":"string","enum":["MATv1"]},{"type":"string","enum":["MATv2"]},{"type":"string","enum":["MATv3"]}]},"serviceId":{"description":"The Morpheus service ID.","anyOf":[{"type":"string","enum":["audio"]},{"type":"string","enum":["morpheus"]}]},"ipType":{"description":"Specifies whether to return internal or external IPs.","anyOf":[{"type":"string","enum":["external"]},{"type":"string","enum":["internal"]}]}},"required":["tokenFormat","serviceId"]},"connectWorldResponse":{"description":"Connection details for a world","type":"object","properties":{"organizationId":{"type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"worldId":{"description":"The ID of a world","type":"string"},"launchContextId":{"description":"The ID of a launch context","type":"string"},"connection":{"description":"Details for a connection to a world.","type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"token":{"type":"string"},"endpoint":{"type":"object","properties":{"ip":{"type":"string"},"port":{"type":"number"}},"required":["ip","port"]}},"required":["id","token","endpoint"]}},"required":["organizationId","projectId","connection"]},"WorldLaunchContext":{"description":"Structure of the launch context linked to a world","type":"object","allOf":[{"description":"The shape of a launch context","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"worldId":{"type":"string"}},"required":["launchContextId","isActive","worldId"]},{"type":"object","properties":{"isPublic":{"type":"boolean"},"projectId":{"type":"string"},"organizationId":{"type":"string"}},"required":["projectId","organizationId"]}]},"GetWorldDeploymentsResponse":{"description":"Details for the World's deployments","type":"array","items":{"type":"object","properties":{"organizationId":{"$ref":"#/components/schemas/organizationId"},"projectId":{"description":"The ID of a project","type":"string"},"worldId":{"description":"The ID of a world","type":"string"},"runId":{"description":"The ID of a world","type":"string"},"createdAt":{"type":"string"},"id":{"description":"The ID of a world deployment","type":"string"},"networking":{"type":"object","properties":{"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]}}}},"required":["scaling"]},"externalId":{"type":"string"},"compute":{"type":"object","properties":{"clusterName":{"type":"string"},"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"type":"string"}},"required":["clusterName","group","region","version"]},"runtime":{"type":"object","properties":{"build":{"type":"object","properties":{"channelId":{"type":"string"},"id":{"type":"string"},"content":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["channelId","id"]},"mapName":{"type":"string"},"liveConfigUrl":{"type":"string"},"durationMinute":{"type":"number"},"args":{"type":"array","items":{"type":"string"}}},"required":["build","mapName"]},"status":{"anyOf":[{"type":"string","enum":["Unknown"]},{"type":"string","enum":["Created"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Degraded"]},{"type":"string","enum":["Failed"]},{"type":"string","enum":["Stopped"]},{"type":"string","enum":["Deleted"]}]}},"required":["organizationId","projectId","worldId","createdAt","id","networking","externalId","compute","runtime","status"]}},"worldDeploymentId":{"description":"The ID of a world deployment","type":"string"},"GetWorldDeploymentsQuery":{"description":"Query params for fetching a World's deployments","type":"object","properties":{"status":{"type":"array","items":{"anyOf":[{"type":"string","enum":["Unknown"]},{"type":"string","enum":["Created"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Degraded"]},{"type":"string","enum":["Failed"]},{"type":"string","enum":["Stopped"]},{"type":"string","enum":["Deleted"]}]}}}},"getWorldsHeaders":{"description":"The headers that define which organization and project to retrieve worlds from for the get worlds endpoint","type":"object","properties":{"x-m2-organization-id":{"$ref":"#/components/schemas/organizationId"},"x-m2-project-id":{"$ref":"#/components/schemas/projectId"}},"required":["x-m2-organization-id"]},"getWorldsResponse":{"description":"Lists all worlds for an organization or project (if specified)","type":"array","items":{"type":"object","properties":{"documentId":{"description":"The ID of a world","type":"string"},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"transient":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"required":["group","region"]},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}},"required":["strategy","scaling"]},"runtime":{"type":"object","properties":{"build":{"description":"The runtime build of a world.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},"mapName":{"pattern":"^\\S.*\\S$|^\\S$","description":"The name of the map the world will run.","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"},"admissionPolicy":{"description":"The policy by which clients may connect to this runtime. Always allowed if not set.","anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]}},"required":["build","mapName"]},"status":{"description":"The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.","type":"object","properties":{"phase":{"description":"The current phase of the world.","anyOf":[{"type":"string","enum":["Inactive"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Stopping"]},{"type":"string","enum":["Error"]}]},"message":{"description":"Message providing human-readable information about the state of the world.","type":"string"},"startedAt":{"description":"Provides information on when the world was last started.","type":"string"},"resolvedBuild":{"description":"Information about the resolved build for the world once it was started.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"organizationId":{"type":"string"},"id":{"type":"string"}},"required":["channelId","tag","organizationId","id"]},"runId":{"description":"The ID of a world","type":"string"}},"required":["phase","message"]},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"sessions":{"type":"object","properties":{"controlPolicy":{"anyOf":[{"type":"string","enum":["Unlimited"]},{"type":"string","enum":["ReplaceOlder"]}]},"streamingTicketPredicate":{"description":"If set, overrides the ticket predicate used to select a streaming slot","type":"string"},"flags":{"type":"object","properties":{"ignoreExpiry":{"default":false,"description":"If set, allows expired sessions to be refreshed","type":"boolean"},"ignoreSlotRenewalErrors":{"default":false,"description":"If set, issues renewing a streaming slot will not invalidate the session","type":"boolean"},"ignoreParentMissing":{"default":false,"description":"If set, issues creating a child session if the parent is invalid","type":"boolean"},"useImmediateMode":{"default":false,"description":"If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity","type":"boolean"}},"required":["ignoreExpiry","ignoreSlotRenewalErrors","ignoreParentMissing","useImmediateMode"]},"forceTravelWorldId":{"description":"If set, causes Sessions belonging to this World to be force-travelled to the specified World ID.","type":"string"}}},"organizationId":{"$ref":"#/components/schemas/organizationId"},"projectId":{"$ref":"#/components/schemas/projectId"},"launchContext":{"description":"The shape of a launch context and extra details including the Organization and Project scope","type":"object","properties":{"launchContextId":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"isActive":{"description":"Defines whether the launch context is live","type":"boolean"},"publicDownload":{"anyOf":[{"description":"Defines if the build is available for public download (i.e. without requiring specific permissions) and the restrictions around it","type":"object","properties":{"enabled":{"description":"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.","type":"boolean"},"enforceAntiCheat":{"type":"boolean"},"allowMac":{"description":"Defines whether the build is compatible with MacOs","type":"boolean"},"allowIos":{"description":"Defines whether the build is compatible with iOS","type":"boolean"}},"required":["enabled"]},{"type":"null"}]},"isWorldTravelOnly":{"type":"boolean"},"worldId":{"allOf":[{"type":"string"},{"description":"The ID of a world","type":"string"}]},"description":{"type":"string"},"errorPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out","type":"string"},"okPageUrl":{"pattern":"^https?://.*$","description":"Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully","type":"string"},"gdnStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using GeForce Now","type":"object","properties":{"cmsId":{"anyOf":[{"type":"string"},{"type":"null"}]},"authorizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"launchMode":{"anyOf":[{"anyOf":[{"type":"string","enum":["same-tab"]},{"type":"string","enum":["same-tab-windowed"]},{"type":"string","enum":["tab"]},{"type":"string","enum":["tab-windowed"]},{"type":"string","enum":["embed"]},{"type":"string","enum":["embed-unsupported"]}]},{"type":"null"}]}}},{"type":"null"}]},"ubitusStreaming":{"anyOf":[{"description":"Defines the necessary information to stream the event using Ubitus","type":"object","properties":{"gameLabel":{"type":"string"},"gameChannel":{"type":"string"}},"required":["gameLabel","gameChannel"]},{"type":"null"}]},"streamManager":{"anyOf":[{"description":"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","type":"object","properties":{"streamContextId":{"type":"string"},"allowForceProvider":{"type":"boolean"},"showProviderOptions":{"type":"boolean"},"useBuildVersion":{"type":"boolean"}},"required":["streamContextId"]},{"type":"null"}]},"bypassBrowserRestrictions":{"description":"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.","type":"boolean"},"enableQueue":{"type":"boolean"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"buildInfo":{"anyOf":[{"type":"object","properties":{"buildChannelId":{"type":"string"},"buildTag":{"type":"string"},"buildType":{"anyOf":[{"type":"string","enum":["client"]},{"type":"string","enum":["editor"]}]}},"required":["buildChannelId","buildTag","buildType"]},{"type":"null"}]},"splashScreenUrl":{"type":"string"},"useWorldSessions":{"type":"boolean"},"pictureUrl":{"allOf":[{"type":"string"},{"type":"string"}]},"isPublic":{"type":"boolean"},"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"permissionVerb":{"description":"The permission level that the user has over this resource.","anyOf":[{"type":"string","enum":["*"]},{"type":"string","enum":["r"]},{"type":"string","enum":["w"]},{"type":"string","enum":["g"]}]}},"required":["launchContextId","name","isActive","worldId","organizationId","projectId","permissionVerb"]},"queueState":{"description":"Information about the number of active and queueing sessions for a world.","type":"object","properties":{"queued":{"type":"number"},"active":{"type":"number"}},"required":["queued","active"]}},"required":["documentId","name","transient","compute","networking","runtime","status","organizationId","projectId"]}},"patchWorldPictureUrlResponse":{"description":"The updated world details","type":"object","properties":{"documentId":{"description":"The ID of a world","type":"string"},"name":{"pattern":"^.+\\S.*$","minLength":1,"maxLength":64,"description":"The name of a world","type":"string"},"description":{"maxLength":256,"description":"The description of a world","type":"string"},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"},"transient":{"description":"Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.","type":"boolean"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"compute":{"description":"Includes details relating to the compute resources that are relevant for deploying the world.","type":"object","properties":{"group":{"description":"The compute group of a world. Controls where the world will be deployed.","default":"production","anyOf":[{"type":"string","enum":["development"]},{"type":"string","enum":["testing"]},{"type":"string","enum":["staging"]},{"type":"string","enum":["production"]},{"type":"string","enum":["bare-metal"]},{"type":"string"}]},"region":{"default":"Europe","description":"The compute region of a world. Controls which region the world will be deployed in.","anyOf":[{"type":"string","enum":["Europe"]},{"type":"string","enum":["europe-west1"]},{"type":"string","enum":["europe-west2"]},{"type":"string","enum":["europe-west3"]},{"type":"string","enum":["europe-west4"]},{"type":"string","enum":["europe-north1"]}]},"version":{"pattern":"^\\S.*\\S$|^\\S$","description":"The compute version of a world.","type":"string"}},"required":["group","region"]},"networking":{"description":"The networking configuration of a world. ","type":"object","properties":{"strategy":{"default":"Default","type":"string","enum":["Default"]},"scaling":{"default":{"profile":"Capacity500"},"description":"The scaling configuration of a world.","type":"object","properties":{"profile":{"description":"The scaling profile of a world. This controls the overall capacity and configuration of a world.","anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"configuration":{}},"required":["profile"]}},"required":["strategy","scaling"]},"runtime":{"type":"object","properties":{"build":{"description":"The runtime build of a world.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},"mapName":{"pattern":"^\\S.*\\S$|^\\S$","description":"The name of the map the world will run.","type":"string"},"durationMinutes":{"type":"number"},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"},"admissionPolicy":{"description":"The policy by which clients may connect to this runtime. Always allowed if not set.","anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]}},"required":["build","mapName"]},"status":{"description":"The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.","type":"object","properties":{"phase":{"description":"The current phase of the world.","anyOf":[{"type":"string","enum":["Inactive"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Stopping"]},{"type":"string","enum":["Error"]}]},"message":{"description":"Message providing human-readable information about the state of the world.","type":"string"},"startedAt":{"description":"Provides information on when the world was last started.","type":"string"},"resolvedBuild":{"description":"Information about the resolved build for the world once it was started.","type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"organizationId":{"type":"string"},"id":{"type":"string"}},"required":["channelId","tag","organizationId","id"]},"runId":{"description":"The ID of a world","type":"string"}},"required":["phase","message"]},"manifest":{"description":"The world manifest, describing server and client permissions.","type":"object","properties":{"serverPermissions":{"type":"array","items":{"type":"string"}},"clientPermissions":{"type":"array","items":{"type":"string"}}},"required":["serverPermissions","clientPermissions"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"sessions":{"type":"object","properties":{"controlPolicy":{"anyOf":[{"type":"string","enum":["Unlimited"]},{"type":"string","enum":["ReplaceOlder"]}]},"streamingTicketPredicate":{"description":"If set, overrides the ticket predicate used to select a streaming slot","type":"string"},"flags":{"type":"object","properties":{"ignoreExpiry":{"default":false,"description":"If set, allows expired sessions to be refreshed","type":"boolean"},"ignoreSlotRenewalErrors":{"default":false,"description":"If set, issues renewing a streaming slot will not invalidate the session","type":"boolean"},"ignoreParentMissing":{"default":false,"description":"If set, issues creating a child session if the parent is invalid","type":"boolean"},"useImmediateMode":{"default":false,"description":"If set, causes streaming slots to be assigned or rejected immediately, rather awaiting capacity","type":"boolean"}},"required":["ignoreExpiry","ignoreSlotRenewalErrors","ignoreParentMissing","useImmediateMode"]},"forceTravelWorldId":{"description":"If set, causes Sessions belonging to this World to be force-travelled to the specified World ID.","type":"string"}}}},"required":["documentId","name","transient","compute","networking","runtime","status"]},"botsParams":{"description":"The world and bot deployment IDs for the bots endpoint","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"},"botDeploymentId":{"description":"The ID of a bot deployment","type":"string"}},"required":["worldId","botDeploymentId"]},"botDeploymentId":{"description":"The ID of a bot deployment","type":"string"},"getBotsResponse":{"description":"All bot deployments for a world","type":"array","items":{"type":"object","properties":{"documentId":{"description":"The ID of a bot deployment","type":"string"},"description":{"maxLength":2048,"type":"string"},"configuration":{"type":"object","properties":{"count":{"exclusiveMinimum":0,"multipleOf":1,"type":"number"},"cpu":{"format":"regex","pattern":"^\\d+(m|\\.\\d\\d?\\d?)?$","type":"string"},"memory":{"format":"regex","pattern":"^\\d+(\\.\\d+)?(m|k|Ki|M|Mi|G|Gi)?$","type":"string"},"args":{"type":"array","items":{"type":"string"}},"durationMinutes":{"exclusiveMinimum":0,"type":"number"}},"required":["count"]},"status":{"type":"object","properties":{"phase":{"anyOf":[{"type":"string","enum":["Pending"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Updating"]},{"type":"string","enum":["Complete"]},{"type":"string","enum":["Failed"]}]},"message":{"type":"string"},"startedAt":{"type":"number"},"worldStartedAt":{"type":"string"},"cluster":{"type":"object","properties":{"name":{"type":"string"},"computeGroup":{"type":"string"}},"required":["name","computeGroup"]}},"required":["phase"]},"metadata":{"type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}}}},"organizationId":{"type":"string"},"projectId":{"type":"string"},"worldId":{"type":"string"}},"required":["documentId","configuration","status","organizationId","projectId","worldId"]}},"postBotDeploymentRequest":{"description":"Create a bot deployment","type":"object","properties":{"description":{"maxLength":2048,"type":"string"},"metadata":{"type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}}}},"count":{"exclusiveMinimum":0,"multipleOf":1,"type":"number"},"cpu":{"format":"regex","pattern":"^\\d+(m|\\.\\d\\d?\\d?)?$","type":"string"},"memory":{"format":"regex","pattern":"^\\d+(\\.\\d+)?(m|k|Ki|M|Mi|G|Gi)?$","type":"string"},"args":{"type":"array","items":{"type":"string"}},"durationMinutes":{"exclusiveMinimum":0,"type":"number"}},"required":["count"]},"getBotDeploymentResponse":{"description":"The details for a bot deployment","type":"object","properties":{"documentId":{"description":"The ID of a bot deployment","type":"string"},"description":{"maxLength":2048,"type":"string"},"configuration":{"type":"object","properties":{"count":{"exclusiveMinimum":0,"multipleOf":1,"type":"number"},"cpu":{"format":"regex","pattern":"^\\d+(m|\\.\\d\\d?\\d?)?$","type":"string"},"memory":{"format":"regex","pattern":"^\\d+(\\.\\d+)?(m|k|Ki|M|Mi|G|Gi)?$","type":"string"},"args":{"type":"array","items":{"type":"string"}},"durationMinutes":{"exclusiveMinimum":0,"type":"number"}},"required":["count"]},"status":{"type":"object","properties":{"phase":{"anyOf":[{"type":"string","enum":["Pending"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Active"]},{"type":"string","enum":["Updating"]},{"type":"string","enum":["Complete"]},{"type":"string","enum":["Failed"]}]},"message":{"type":"string"},"startedAt":{"type":"number"},"worldStartedAt":{"type":"string"},"cluster":{"type":"object","properties":{"name":{"type":"string"},"computeGroup":{"type":"string"}},"required":["name","computeGroup"]}},"required":["phase"]},"metadata":{"type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}}}},"organizationId":{"type":"string"},"projectId":{"type":"string"},"worldId":{"type":"string"}},"required":["documentId","configuration","status","organizationId","projectId","worldId"]},"patchBotDeploymentRequest":{"description":"Patch a bot deployment","type":"object","properties":{"count":{"exclusiveMinimum":0,"multipleOf":1,"type":"number"},"cpu":{"format":"regex","pattern":"^\\d+(m|\\.\\d\\d?\\d?)?$","type":"string"},"memory":{"format":"regex","pattern":"^\\d+(\\.\\d+)?(m|k|Ki|M|Mi|G|Gi)?$","type":"string"},"args":{"type":"array","items":{"type":"string"}},"durationMinutes":{"exclusiveMinimum":0,"type":"number"},"metadata":{"type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}}}}},"required":["count"]},"getMetricResponse":{"description":"Metric values for a world deployment","type":"array","items":{"type":"object","properties":{"time":{"type":"number"},"value":{"type":"number"}},"required":["time","value"]}},"worldMetricParams":{"description":"The world and metric IDs for the metrics endpoint","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"},"metricId":{"description":"The name of a world metric","anyOf":[{"type":"string","enum":["fps"]},{"type":"string","enum":["server-fps"]},{"type":"string","enum":["clients-connected"]},{"type":"string","enum":["bots-connected"]},{"type":"string","enum":["bots-ram-average"]},{"type":"string","enum":["bots-ram-max"]},{"type":"string","enum":["player-fps-50"]},{"type":"string","enum":["player-fps-90"]},{"type":"string","enum":["server-ram"]},{"type":"string","enum":["server-mem-limit"]},{"type":"string","enum":["server-critical-errors"]},{"type":"string","enum":["server-http-errors"]},{"type":"string","enum":["bots-critical-errors"]},{"type":"string","enum":["bots-major-errors"]},{"type":"string","enum":["bots-http-errors"]}]}},"required":["worldId","metricId"]},"metricId":{"description":"The name of a world metric","anyOf":[{"type":"string","enum":["fps"]},{"type":"string","enum":["server-fps"]},{"type":"string","enum":["clients-connected"]},{"type":"string","enum":["bots-connected"]},{"type":"string","enum":["bots-ram-average"]},{"type":"string","enum":["bots-ram-max"]},{"type":"string","enum":["player-fps-50"]},{"type":"string","enum":["player-fps-90"]},{"type":"string","enum":["server-ram"]},{"type":"string","enum":["server-mem-limit"]},{"type":"string","enum":["server-critical-errors"]},{"type":"string","enum":["server-http-errors"]},{"type":"string","enum":["bots-critical-errors"]},{"type":"string","enum":["bots-major-errors"]},{"type":"string","enum":["bots-http-errors"]}]},"worldMetricQueryString":{"description":"Query parameters for world metrics endpoint","type":"object","properties":{"startTime":{"description":"The start timestamp for the metrics query in unix seconds","type":"number"},"endTime":{"description":"The end timestamp for the metrics query in unix seconds","type":"number"},"deploymentId":{"description":"The deployment ID for the metrics query","type":"string"},"source":{"description":"The source of the queried metrics","anyOf":[{"type":"string","enum":["GrafanaCloud"]},{"type":"string","enum":["GoogleCloudMonitoring"]}]}}},"GetWorldTravelLocationsHeaders":{"description":"The headers that define which organization and project to retrieve worlds from for the travel locations endpoint","type":"object","properties":{"x-m2-organization-id":{"$ref":"#/components/schemas/organizationId"},"x-m2-project-id":{"$ref":"#/components/schemas/projectId"}}},"GetWorldTravelLocationsResponse":{"description":"List of worlds that the client can launch into","type":"object","properties":{"worlds":{"type":"array","items":{"type":"object","properties":{"deployment":{"type":"string"},"map":{"type":"string"},"buildId":{"type":"string"},"organizationId":{"type":"string"},"projectId":{"type":"string"},"launchContextId":{"type":"string"},"launchContextName":{"type":"string"},"worldId":{"type":"string"},"worldName":{"type":"string"},"liveConfigUrl":{"type":"string"},"contentId":{"type":"string"},"metadata":{"description":"The metadata of a world. Includes annotations and labels used to customize the world deployments.","type":"object","properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"maxLength":63,"type":"string"}}}},"queueState":{"description":"Information about the number of active and queueing sessions for a world.","type":"object","properties":{"queued":{"type":"number"},"active":{"type":"number"}},"required":["queued","active"]},"admission":{"type":"object","properties":{"policy":{"anyOf":[{"type":"string","enum":["Open"]},{"type":"string","enum":["Automatic"]},{"type":"string","enum":["Closed"]}]},"capacity":{"minimum":0,"maximum":20000,"description":"The maximum number of clients that this World can accept. Unbound if not set.","type":"number"}},"required":["policy"]},"pictureUrl":{"format":"uri","description":"The picture URL of a world","type":"string"}},"required":["deployment","map","buildId"]}}},"required":["worlds"]},"organizationHeader":{"description":"Organization header automatically added by the load balancer","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"}},"required":["x-m2-organization-id"]},"PatchDeploymentParams":{"description":"Deployment ID","type":"object","properties":{"deploymentId":{"description":"The ID of a deployment","type":"string"}},"required":["deploymentId"]},"deploymentId":{"description":"The ID of a deployment","type":"string"},"PatchDeploymentBody":{"description":"The request body for updating a deployment","type":"object","properties":{"projectId":{"type":"string"},"launchContextId":{"type":"string"},"worldId":{"type":"string"},"ip":{"type":"object","properties":{"audioServer":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]},"mark":{"type":"array","items":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}},"proxies":{"type":"array","items":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}},"runtime":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}}},"componentStatuses":{"type":"object","additionalProperties":{"type":"object","properties":{"expectedComponentCount":{"type":"number"},"statuses":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"phase":{"type":"string"},"ready":{"type":"boolean"},"endpoint":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}},"required":["name","phase","ready"]}}},"required":["expectedComponentCount","statuses"]}},"mapName":{"type":"string"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"annotations":{"type":"object","additionalProperties":{"type":"string"}},"clusterName":{"type":"string"},"bareMetalHost":{"type":"string"},"versions":{"type":"object","allOf":[{"type":"object","properties":{"morpheus":{"type":"string"},"colosseum":{"type":"string"}}},{"type":"object","properties":{"set":{"type":"string"}}}]}},"required":["componentStatuses"]},"PatchDeploymentResponse":{"description":"Updated deployment with status and IPs","anyOf":[{"type":"object","properties":{"organizationId":{"type":"string"},"projectId":{"type":"string"},"launchContextId":{"type":"string"},"worldId":{"type":"string"},"id":{"type":"string"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"annotations":{"type":"object","additionalProperties":{"type":"string"}},"region":{"type":"string"},"clusterName":{"type":"string"},"ip":{"type":"object","properties":{"audioServer":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]},"mark":{"type":"array","items":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}},"proxies":{"type":"array","items":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}},"runtime":{"type":"object","properties":{"externalIp":{"type":"string"},"internalIp":{"type":"string"},"port":{"type":"number"}},"required":["externalIp","port"]}}},"versions":{"type":"object","allOf":[{"type":"object","properties":{"morpheus":{"type":"string"},"colosseum":{"type":"string"}},"required":["morpheus","colosseum"]},{"type":"object","properties":{"set":{"type":"string"}},"required":["set"]}]},"status":{"anyOf":[{"type":"string","enum":["Unknown"]},{"type":"string","enum":["Created"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Degraded"]},{"type":"string","enum":["Failed"]},{"type":"string","enum":["Stopped"]},{"type":"string","enum":["Deleted"]}]},"mapName":{"type":"string"},"args":{"type":"array","items":{"type":"string"}},"liveContent":{"type":"object","properties":{"id":{"type":"string"},"mapName":{"type":"string"},"clientStartupMapName":{"type":"string"}},"required":["id","mapName"]},"capacity":{"type":"number"},"_liveConfigUrl":{"type":"string"},"_entryScript":{"type":"string"},"_duration":{"type":"number"}},"required":["organizationId","projectId","id","versions","status","mapName"]},{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["Unknown"]},{"type":"string","enum":["Created"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Degraded"]},{"type":"string","enum":["Failed"]},{"type":"string","enum":["Stopped"]},{"type":"string","enum":["Deleted"]}]},"versions":{"type":"object","allOf":[{"type":"object","properties":{"morpheus":{"type":"string"},"colosseum":{"type":"string"}}},{"type":"object","properties":{"set":{"type":"string"}}}]}}}]},"organizationAndProjectHeader":{"description":"Organization and project headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"}},"required":["x-m2-organization-id","x-m2-project-id"]},"GetDeploymentLogsParams":{"description":"World ID","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"}},"required":["worldId"]},"GetDeploymentLogsResponse":{"description":"URL to download the latest Unreal server log","type":"object","properties":{"downloadUrl":{"type":"string"}},"required":["downloadUrl"]},"LocalWorldAuthRequest":{"description":"Request sent for a local world authentication attempt","type":"object","properties":{"userType":{"description":"The user type to authenticate with this local world","anyOf":[{"type":"string","enum":["Server"]},{"type":"string","enum":["Client"]}]}},"required":["userType"]},"LocalWorldAuthResponse":{"description":"Response sent for a successful local world authentication request","type":"object","properties":{"accessToken":{"description":"The World Access Token to be used for this user","type":"string"}},"required":["accessToken"]},"postLocalWorldRequest":{"description":"Details of the new world that are dependent on the editor","type":"object","properties":{"buildId":{"description":"The ID of a build package","type":"string"}},"required":["buildId"]},"buildId":{"description":"The ID of a build package","type":"string"},"postLocalWorldResponse":{"description":"The new world's ID, if created successfully","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"}},"required":["worldId"]},"worldAndUserParams":{"description":"The world and user IDs","type":"object","properties":{"worldId":{"description":"The ID of a world","type":"string"},"userId":{"description":"The ID of a user","type":"string"}},"required":["worldId","userId"]},"userId":{"description":"The ID of a user","type":"string"},"getWorldUserGameRolesResponse":{"description":"Game roles scoped to a world for a specified user","type":"array","items":{"type":"string"}},"accessResponse":{"description":"Indicates if a user has access to a world","type":"object","properties":{"userId":{"description":"The ID of a user","type":"string"},"hasAccess":{"description":"true if the user can enter the world, false otherwise","type":"boolean"}},"required":["userId","hasAccess"]},"getScalingProfilesResponse":{"description":"Lists all scaling profiles","type":"array","items":{"description":"The details of a scaling profile","type":"object","properties":{"name":{"anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"estimatedCapacity":{"type":"number"},"maxBotsPerWorld":{"type":"number"},"resourceConfiguration":{"type":"object","properties":{"server":{"type":"object","properties":{"memoryLimit":{"anyOf":[{"type":"string"},{"type":"number"}]}}}},"required":["server"]}},"required":["name","estimatedCapacity","maxBotsPerWorld","resourceConfiguration"]}},"scalingProfile":{"description":"The details of a scaling profile","type":"object","properties":{"name":{"anyOf":[{"type":"string","enum":["Capacity30"]},{"type":"string","enum":["Tiny"]},{"type":"string","enum":["Capacity100"]},{"type":"string","enum":["Small"]},{"type":"string","enum":["Capacity500"]},{"type":"string","enum":["Medium"]},{"type":"string","enum":["Capacity1500"]},{"type":"string","enum":["Large5K"]},{"type":"string","enum":["Capacity5000"]},{"type":"string","enum":["Large"]},{"type":"string","enum":["Capacity15000"]},{"type":"string","enum":["Custom"]}]},"estimatedCapacity":{"type":"number"},"maxBotsPerWorld":{"type":"number"},"resourceConfiguration":{"type":"object","properties":{"server":{"type":"object","properties":{"memoryLimit":{"anyOf":[{"type":"string"},{"type":"number"}]}}}},"required":["server"]}},"required":["name","estimatedCapacity","maxBotsPerWorld","resourceConfiguration"]}}},"paths":{"/":{"get":{"operationId":"getWorlds","summary":"Get worlds for an organization","tags":["Worlds","public"],"description":"Retrieves and returns all worlds that belong to the given Organization. Can also additionally filter by project if a project ID is passed in the headers.","parameters":[{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":false}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Lists all worlds for an organization or project (if specified)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getWorldsResponse"}}}}}},"post":{"operationId":"createWorld","summary":"Create a world","tags":["Worlds","public"],"description":"Creates a world in the given Organization and Project. Checks if the user can create a world with the given size.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postWorldRequest"}}}},"parameters":[{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The world's ID, if created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/postWorldResponse"}}}}}}},"/travel/locations/":{"get":{"operationId":"getWorldTravelLocations","summary":"Returns a list of worlds that the client can launch in to","tags":["Worlds","public"],"parameters":[{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":false},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":false}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"List of worlds that the client can launch into","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorldTravelLocationsResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/resolveBuildAndContent/":{"post":{"operationId":"resolveBuild","summary":"Resolve world build and content","tags":["Worlds"],"description":"Takes various build variables and resolves them to a single build package.","requestBody":{"content":{"application/json":{"schema":{"description":"The runtime build of a world. A build can be specified by a channel and tag, or by a content ID.","anyOf":[{"type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["channelId","tag"]},{"type":"object","properties":{"channelId":{"description":"The ID of a build channel.","type":"string"},"tag":{"pattern":"^\\S.*\\S$|^\\S$","description":"The tag of a build.","type":"string"},"content":{"description":"The ID of a world builder content.","type":"object","properties":{"id":{"pattern":"^[\\w-]+$","type":"string"}},"required":["id"]}},"required":["content"]}]}}},"description":"The runtime build of a world. A build can be specified by a channel and tag, or by a content ID."},"parameters":[{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"204":{"description":"Build and content resolved successfully"},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}},"5XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/scalingProfiles/":{"get":{"operationId":"getScalingProfiles","summary":"Get scaling profiles","tags":["Worlds"],"description":"Retrieves all scaling profiles","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Lists all scaling profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getScalingProfilesResponse"}}}}}}},"/{worldId}/":{"get":{"operationId":"getWorld","summary":"Get the details of a world","tags":["Worlds","public"],"description":"Retrieves and returns the specified world and linked launch context.","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The details for a world","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getWorldResponse"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"patch":{"operationId":"updateWorld","summary":"Update the details of a world","tags":["Worlds","public"],"description":"Updates the specified world and returns the resulting new world data if successful.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWorldRequest"}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The updated world details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWorldResponse"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"delete":{"operationId":"deleteWorld","summary":"Delete a world","tags":["Worlds","public"],"description":"Deletes the specified world.","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Empty response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteWorldResponse"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/{worldId}/bots/":{"get":{"operationId":"getWorldBots","summary":"Get world bot deployments","tags":["Worlds Bots","public"],"description":"Get all bot deployments for the specified world","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"All bot deployments for a world","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getBotsResponse"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"post":{"operationId":"createBotDeployment","summary":"Create world bot deployment","tags":["Worlds Bots","public"],"description":"Create a bot deployment for the specified world with the provided bot count","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postBotDeploymentRequest"}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/{worldId}/bots/{botDeploymentId}/":{"get":{"operationId":"getBotDeployment","summary":"Get world bot deployment","tags":["Worlds Bots","public"],"description":"Get the details for a specific bot deployment for the specified world.","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"type":"string"},"in":"path","name":"botDeploymentId","required":true,"description":"The ID of a bot deployment"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The details for a bot deployment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getBotDeploymentResponse"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"patch":{"operationId":"updateBotDeployment","summary":"Update world bot deployment","tags":["Worlds Bots","public"],"description":"Update a bot deployment for the specified world. This can be used to alter the bot count in a bot deployment.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchBotDeploymentRequest"}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"type":"string"},"in":"path","name":"botDeploymentId","required":true,"description":"The ID of a bot deployment"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}},"delete":{"operationId":"deleteBotDeployment","summary":"Delete world bot deployment","tags":["Worlds Bots","public"],"description":"Stop a bot deployment for the specified world","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"type":"string"},"in":"path","name":"botDeploymentId","required":true,"description":"The ID of a bot deployment"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/{worldId}/deployments/":{"get":{"operationId":"getWorldDeployments","summary":"Get world deployments","tags":["World Deployments"],"description":"Returns the specified world's deployments. Optionally can be filtered by status, provided in the query string.","parameters":[{"schema":{"type":"array","items":{"anyOf":[{"type":"string","enum":["Unknown"]},{"type":"string","enum":["Created"]},{"type":"string","enum":["Starting"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Degraded"]},{"type":"string","enum":["Failed"]},{"type":"string","enum":["Stopped"]},{"type":"string","enum":["Deleted"]}]}},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Details for the World's deployments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorldDeploymentsResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/{worldId}/pictureUrl/":{"patch":{"operationId":"setWorldPictureUrl","summary":"World update picture URL","tags":["Worlds","public"],"description":"Update the picture URL of a world","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The updated world details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWorldPictureUrlResponse"}}}},"400":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}},"404":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}},"503":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/{worldId}/start/":{"post":{"operationId":"startWorld","summary":"Start a world","tags":["Worlds","public"],"description":"Transitions the phase of the world to Starting, which will subsequently launch the underlying deployments. With this transition, the world run ID and startedAt timestamp are reset.","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Empty response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/startWorldResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/{worldId}/stop/":{"post":{"operationId":"stopWorld","summary":"Stop a world","tags":["Worlds","public"],"description":"Transition the world phase to Stopped, which subsequently stops underlying deployments.","parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"$ref":"#/components/schemas/organizationId"},"in":"header","name":"x-m2-organization-id","required":true},{"schema":{"$ref":"#/components/schemas/projectId"},"in":"header","name":"x-m2-project-id","required":true}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Empty response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stopWorldResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/{worldId}/users/{userId}/access/":{"get":{"operationId":"getWorldAccess","summary":"Check if a user has access to a world","tags":["Worlds","public"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"worldId","required":true,"description":"The ID of a world"},{"schema":{"type":"string"},"in":"path","name":"userId","required":true,"description":"The ID of a user"},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Indicates if a user has access to a world","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accessResponse"}}}},"4XX":{"description":"HTTP error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/httpError"}}}}}}},"/public/":{"get":{"operationId":"getPublicWorlds","summary":"Get all public worlds across all organizations.","tags":["Worlds","public"],"description":"Retrieves and returns all worlds that are marked as public and active across all organizations.","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Lists all worlds for an organization or project (if specified)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getWorldsResponse"}}}}}}}},"servers":[{"url":"https://{organizationId}.m2worlds.io/api/worlds","variables":{"organizationId":{"default":"your-organization-id"}}}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}