World Builder
Manages World Builder content and mods
Experimental feature: this API is likely to change.
Last updated
Manages World Builder content and mods
Experimental feature: this API is likely to change.
Last updated
Provides information about the service status.
Provides information about the service status.
Checks the user's permissions for World Builder functionalities. Optionally provide an assetsId
or modId
query parameter to check access for a specific resource.
User's access permissions for World Builder functionalities
Indicates if the user can upload assets
Indicates if the user can upload content
Indicates if the user can upload to the specified asset ID
Indicates if the user can upload to the specified mod ID
Retrieves a list of content IDs for a project. You can filter the results by providing query parameters that correspond to properties in the WorldBuilderContentShape
.
List of content IDs available in World Builder, representing unique identifiers for various content items
Deletes a specific content ID.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
Empty response indicating successful content deletion
Empty response indicating successful content deletion
Retrieves the data for an asset using its assetsId
.
Unique identifier of the asset
Detailed information about a specific asset
Retrieves the asset manifests associated with a mod using its modId
. Optionally provide the buildId
query parameter to filter the manifests by a specific build.
Response containing the relevant asset manifests associated with the requested mod and build.
Array of manifest objects containing details about mod assets
Retrieves a list of mod IDs that the user has access to within an organization and project.
The relevant mods associated with the project.
Confirms the upload of world builder content files and optionally associates the content with a mod.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
Name of the mod being uploaded (optional)
ID of the mod being uploaded (optional)
Response confirming successful upload completion
Unique identifier of the created or updated mod
Creates a new asset.
Response containing the ID of the newly created asset
Unique identifier of the newly created asset
Generates a signed upload URL for uploading files to an asset version using its assetsId
and versionId
.
Unique identifier of the asset
Unique identifier of the asset version
Response containing the signed URL for file upload
Signed URL for uploading the asset version file
Retrieves a list of mods that the user has access to within an organization.
The relevant mods associated with the organization.
Unique identifier for the mod
Name of the mod
Description of the mod
URL of the mod's picture
The live content ID associated with the mod
The ID of a project
Retrieves the download information for an asset version using its assetsId
and versionId
.
Unique identifier of the asset
Unique identifier of the asset version
Information required to download all files for an asset version
Updates an asset's name and description.
Unique identifier of the asset
Updated asset information after modification
Creates a new version for a specific asset.
Unique identifier of the asset
Release version information
Response containing the ID of the newly created asset version
Unique identifier of the newly created asset version
Retrieves a list of versions for an asset using its assetsId
.
Unique identifier of the asset
List of asset versions with creation timestamps
Release version information
Updates the picture for an assets
Unique identifier of the asset
Updated asset information after modification
Updated asset information after modification
Retrieves a list of assets accessible to the user.
List of assets with detailed information
The ID of a project
Indicates if the user has write permissions for this asset
Retrieves the base URL, signed HTTP cookie, and file metadata necessary to download the world builder content for a world.
The response from the get world content endpoint, containing file information and download details
Array of downloadable files associated with the world content
Base URL for downloading the content files
Authentication cookie for secure file downloads
Name of the plugin associated with this world content
Indicates whether patching should be used for this content
Optional identifier for the mod associated with this world content
Retrieves the base URL, signed HTTP cookie, and file metadata necessary to download the world builder content for a deployment.
Unique identifier of the deployment
Response containing deployment content information and download details
Array of downloadable files for the deployment
Base URL for file downloads
Authentication cookie for file downloads
Name of the plugin associated with the deployment
Indicates if patching should be used for this deployment
Optional ID of the mod associated with the deployment
Creates new content for a specific project.
Response containing the ID of the newly created content in World Builder
Unique identifier for the created content, used for future references and operations
Generates signed GCS upload URLs for uploading files to content using its contentId
. Optionally provide the resumable
query parameter to generate resumable upload URLs.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
List of files to be uploaded
Response containing signed URLs for file uploads
Updates an asset version.
Unique identifier of the asset
Release version information
Updated asset version information after modification
Release version information
Retrieves the data for content using its contentId
.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
Detailed information about a specific World Builder content
Updates the maps for a specific content ID.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
Updated World Builder content after modification
Retrieves a mod and its associated content using the mod's modId
. The response also includes the user's write access permissions for the mod.
The response when getting a mod