World Builder

Manages World Builder content and mods

Experimental feature: this API is likely to change.

Get World Builder Access

Checks the user's permissions for World Builder functionalities. Optionally provide an assetsId or modId query parameter to check access for a specific resource.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/access/

Authorization

BearerAuth

Query parameters

Header parameters

Response

200

User's access permissions for World Builder functionalities

Body

application/json

canUploadAssets*boolean

Indicates if the user can upload assets

canUploadContent*boolean

Indicates if the user can upload content

canUploadToAssetsIdboolean

Indicates if the user can upload to the specified asset ID

canUploadToModIdboolean

Indicates if the user can upload to the specified mod ID

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/access/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "canUploadAssets": false,
  "canUploadContent": false,
  "canUploadToAssetsId": false,
  "canUploadToModId": false
}

Get Assets

Retrieves a list of assets accessible to the user.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/assets/

Authorization

BearerAuth

Header parameters

Response

2004XX

List of assets with detailed information

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

extraMediaarray of assetsExtraMedia (object)

projectId*projectId (string)

The ID of a project

canUserWrite*boolean

Indicates if the user has write permissions for this asset

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  {
    "documentId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "type": "Plugin",
    "extraMedia": [
      {
        "type": "Image",
        "url": "text",
        "order": 0
      }
    ],
    "projectId": "text",
    "canUserWrite": false
  }
]

Get Asset

Retrieves the data for an asset using its assetsId.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/

Authorization

BearerAuth

Path parameters

assetsId*string

Unique identifier of the asset

Header parameters

Response

2004XX

Detailed information about a specific asset

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

extraMediaarray of assetsExtraMedia (object)

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "text",
  "type": "Plugin",
  "extraMedia": [
    {
      "type": "Image",
      "url": "text",
      "order": 0
    }
  ]
}

Update Asset

Updates an asset's name and description.

PATCHhttps://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/

Authorization

BearerAuth

Path parameters

assetsId*string

Unique identifier of the asset

Header parameters

Response

2004XX

Updated asset information after modification

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

extraMediaarray of assetsExtraMedia (object)

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "text",
  "type": "Plugin",
  "extraMedia": [
    {
      "type": "Image",
      "url": "text",
      "order": 0
    }
  ]
}

Get Asset Versions

Retrieves a list of versions for an asset using its assetsId.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/{version}/

Authorization

BearerAuth

Path parameters

assetsId*string

Unique identifier of the asset

Header parameters

Response

2014XX

List of asset versions with creation timestamps

Body

application/json

documentId*string

status*any of

enumenum

description*string

buildId*string

files*array of assetsVersionFile (object)

releaseobject

Release version information

dependenciesarray of object

contentIdstring

createTimeMillis*number

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/{version}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2014XX

[
  {
    "documentId": "text",
    "status": "Pending",
    "description": "text",
    "buildId": "text",
    "files": [
      {
        "name": "text",
        "sizeBytes": 0,
        "md5hash": "text"
      }
    ],
    "release": {
      "name": "text",
      "semanticVersion": "text"
    },
    "dependencies": [
      {
        "assetsId": "text",
        "versionId": "text"
      }
    ],
    "contentId": "text",
    "createTimeMillis": 0
  }
]

Update Asset Version

Updates an asset version.

PATCHhttps://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/{version}/{versionId}/

Authorization

BearerAuth

Path parameters

assetsId*string

Unique identifier of the asset

Header parameters

Body

application/json

statusany of

enumenum

descriptionstring

releaseobject

Release version information

dependenciesarray of object

contentIdstring

Response

2014XX

Updated asset version information after modification

Body

application/json

documentId*string

status*any of

enumenum

description*string

buildId*string

files*array of assetsVersionFile (object)

releaseobject

Release version information

dependenciesarray of object

contentIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/{version}/{versionId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

2014XX

{
  "documentId": "text",
  "status": "Pending",
  "description": "text",
  "buildId": "text",
  "files": [
    {
      "name": "text",
      "sizeBytes": 0,
      "md5hash": "text"
    }
  ],
  "release": {
    "name": "text",
    "semanticVersion": "text"
  },
  "dependencies": [
    {
      "assetsId": "text",
      "versionId": "text"
    }
  ],
  "contentId": "text"
}

Updates assets picture

Updates the picture for an assets

PATCHhttps://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/pictureUrl/

Authorization

BearerAuth

Path parameters

assetsId*string

Unique identifier of the asset

Header parameters

Response

200400404413503

Updated asset information after modification

Body

application/json

PatchAssetsResponseSchema (any)

Updated asset information after modification

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/pictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

400404413503

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Get Content IDs

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.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/content/

Authorization

BearerAuth

Header parameters

Response

2004XX

List of content IDs available in World Builder, representing unique identifiers for various content items

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  "text"
]

Create Content

Creates new content for a specific project.

POSThttps://your-organization-id.m2worlds.io/api/world-builder/content/

Authorization

BearerAuth

Header parameters

Body

application/json

description*string

buildId*string

pluginName*string

maps*array of object

patchTypeany of

enumenumenum

Response

2014XX

Response containing the ID of the newly created content in World Builder

Body

application/json

contentId*string

Unique identifier for the created content, used for future references and operations

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "buildId": "text",
      "pluginName": "text",
      "maps": [
        {
          "name": "text",
          "longPackageName": "text",
          "description": "text",
          "pictureUrl": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

2014XX

{
  "contentId": "text"
}

Get Content

Retrieves the data for content using its contentId.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/

Authorization

BearerAuth

Path parameters

contentId*string

Unique identifier of the World Builder content to operate on, used in various content-related API endpoints

Header parameters

Response

2004XX

Detailed information about a specific World Builder content

Body

application/json

documentId*string

description*string

status*any of

enumenum

buildId*string

creatorId*string

pluginName*string

maps*array of object

files*array of object

patchTypeany of

enumenumenum

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "documentId": "text",
  "description": "text",
  "status": 0,
  "buildId": "text",
  "creatorId": "text",
  "pluginName": "text",
  "maps": [
    {
      "name": "text",
      "longPackageName": "text",
      "description": "text",
      "pictureUrl": "text",
      "roles": [
        "text"
      ]
    }
  ],
  "files": [
    {
      "name": "text",
      "platform": "text",
      "configuration": "text",
      "sizeBytes": 0,
      "md5hash": "text",
      "type": "Pak"
    }
  ],
  "patchType": "None"
}

Update Content

Updates the maps for a specific content ID.

PATCHhttps://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/

Authorization

BearerAuth

Path parameters

contentId*string

Unique identifier of the World Builder content to operate on, used in various content-related API endpoints

Header parameters

Body

application/json

maps*array of object

Response

2004XX

Updated World Builder content after modification

Body

application/json

documentId*string

description*string

status*any of

enumenum

buildId*string

creatorId*string

pluginName*string

maps*array of object

files*array of object

patchTypeany of

enumenumenum

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "maps": [
        {
          "name": "text",
          "longPackageName": "text",
          "description": "text",
          "pictureUrl": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

2004XX

{
  "documentId": "text",
  "description": "text",
  "status": 0,
  "buildId": "text",
  "creatorId": "text",
  "pluginName": "text",
  "maps": [
    {
      "name": "text",
      "longPackageName": "text",
      "description": "text",
      "pictureUrl": "text",
      "roles": [
        "text"
      ]
    }
  ],
  "files": [
    {
      "name": "text",
      "platform": "text",
      "configuration": "text",
      "sizeBytes": 0,
      "md5hash": "text",
      "type": "Pak"
    }
  ],
  "patchType": "None"
}

Delete Content

Deletes a specific content ID.

DELETEhttps://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/

Authorization

BearerAuth

Path parameters

contentId*string

Unique identifier of the World Builder content to operate on, used in various content-related API endpoints

Header parameters

Response

2044XX

Empty response indicating successful content deletion

Body

application/json

DeleteWorldBuilderContentResponse (null)

Empty response indicating successful content deletion

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

4XX

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Get Signed Upload URLs

Generates signed GCS upload URLs for uploading files to content using its contentId. Optionally provide the resumable query parameter to generate resumable upload URLs.

POSThttps://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/requestUploads/

Authorization

BearerAuth

Path parameters

contentId*string

Unique identifier of the World Builder content to operate on, used in various content-related API endpoints

Query parameters

Header parameters

Body

application/json

files*array of object

List of files to be uploaded

Response

2004XX

Response containing signed URLs for file uploads

Body

application/json

uploadFiles*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/requestUploads/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "files": [
        {
          "name": "text",
          "platform": "text",
          "sizeBytes": 0,
          "md5hash": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

2004XX

{
  "uploadFiles": [
    {
      "uploadUrl": "text",
      "fileIdentifier": {
        "name": "text",
        "platform": "text",
        "configuration": "text"
      }
    }
  ]
}

Confirm Content Upload

Confirms the upload of world builder content files and optionally associates the content with a mod.

POSThttps://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/confirmUploads/

Authorization

BearerAuth

Path parameters

contentId*string

Unique identifier of the World Builder content to operate on, used in various content-related API endpoints

Header parameters

Body

application/json

modNamestring

Name of the mod being uploaded (optional)

modIdstring

ID of the mod being uploaded (optional)

assetsIdstring

ID of the assets of the template this project being uploaded originates from

assetsVersionIdstring

ID of the version of the assets of the template this project being uploaded originates from

Response

2004XX

Response confirming successful upload completion

Body

application/json

modId*string

Unique identifier of the created or updated mod

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/confirmUploads/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

2004XX

{
  "modId": "text"
}

Get Mods

Retrieves a list of mods that the user has access to within an organization.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/mods/

Authorization

BearerAuth

Header parameters

Response

2004XX

The relevant mods associated with the organization.

Body

application/json

modId*string

Unique identifier for the mod

name*string

Name of the mod

description*string

Description of the mod

pictureUrlstring

URL of the mod's picture

liveContentId*string

The live content ID associated with the mod

projectId*projectId (string)

The ID of a project

canUserWrite*boolean

lastUploadTime*number

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/mods/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  {
    "modId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "liveContentId": "text",
    "projectId": "text",
    "canUserWrite": false,
    "lastUploadTime": 0
  }
]

Get Mod IDs

Retrieves a list of mod IDs that the user has access to within an organization and project.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/mods/mapping/

Authorization

BearerAuth

Header parameters

Response

2004XX

The relevant mods associated with the project.

Body

application/json

mods*object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/mods/mapping/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{}

Get Mod

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.

GEThttps://your-organization-id.m2worlds.io/api/world-builder/mods/{modId}/

Authorization

BearerAuth

Path parameters

modId*string

Query parameters

Header parameters

Response

2004XX

The response when getting a mod

Body

application/json

mod*object

content*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/mods/{modId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "mod": {
    "modId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "liveContentId": "text",
    "canUserWrite": false,
    "lastUploadTime": 0,
    "modContentCount": 0
  },
  "content": [
    {
      "documentId": "text",
      "description": "text",
      "status": 0,
      "buildId": "text",
      "creatorId": "text",
      "pluginName": "text",
      "maps": [
        {
          "name": "text",
          "longPackageName": "text",
          "description": "text",
          "pictureUrl": "text",
          "roles": [
            "text"
          ]
        }
      ],
      "files": [
        {
          "name": "text",
          "platform": "text",
          "configuration": "text",
          "sizeBytes": 0,
          "md5hash": "text",
          "type": "Pak"
        }
      ],
      "patchType": "None",
      "createTimeMillis": 0
    }
  ]
}

Service health check

GEThttps://your-organization-id.m2worlds.io/api/world-builder/healthz

Response

200

Provides information about the service status.

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text