World Builder

Manages World Builder content and mods

Experimental feature: this API is likely to change.

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.

get

/content/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/content/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

[
  "text"
]

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

Create Content

Creates new content for a specific project.

post

/content/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

descriptionstringrequired

buildIdstringrequired

pluginNamestringrequired

patchTypeany of

mapsobject[]required

filesobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/content/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"description":"text","buildId":"text","pluginName":"text","patchType":"None","maps":[{"name":"text","longPackageName":"text","description":"text","pictureUrl":"text","roles":[null]}],"files":[{"name":"text","platform":"text","sizeBytes":1,"md5hash":"text","metadata":{},"type":"Pak"}]}'

201

4XX

201

{
  "contentId": "text"
}

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

Get Content

Retrieves the data for content using its contentId.

get

/content/{contentId}//

Authorizations

Path parameters

contentIdstringrequired

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

Header parameters

x-m2-organization-idnull

x-m2-project-idnull

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

Detailed information about a specific World Builder content

Update Content

Updates the maps for a specific content ID.

patch

/content/{contentId}//

Authorizations

Path parameters

contentIdstringrequired

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

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

mapsobject[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"maps":[{"name":"text","longPackageName":"text","description":"text","pictureUrl":"text","roles":[null]}]}'

200

4XX

200

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

Updated World Builder content after modification, including organization, project, and mod IDs

Delete Content

Deletes a specific content ID.

delete

/content/{contentId}//

Authorizations

Path parameters

contentIdstringrequired

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

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/content/{contentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

204

4XX

204

No body

Empty response indicating successful content deletion

Get Mods

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

get

/mods/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/mods/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

4XX

200

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

The relevant mods associated with the organization.

Get Mod IDs

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

get

/mods/mapping/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/mods/mapping/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

{
  "mods": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

The relevant mods associated with the project.

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.

get

/mods/{modId}//

Authorizations

Path parameters

modIdstringrequired

Query parameters

limitnumber

Number of documents to return per page

startAfterstring

Unique id of the returned value object that the query should start after

endBeforestring

Unique id of the returned value object that the query should end before

orderByobject[]

searchByobject

filterByobject

Filter by field and values. NOTE: This is not supported yet.

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/world-builder/mods/{modId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

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

The response when getting a mod