world builder

Manages world builder content and mods to be called from Unreal or Buildkite

Experimental feature: this API is likely to change.

Query user access to world builder workflows

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

Authorization

BearerAuth

Query parameters

Header parameters

Response

200

Default Response

Body

application/json

canUploadAssets*boolean

canUploadContent*boolean

canUploadToAssetsIdboolean

canUploadToModIdboolean

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 the list of assets with a given org that a user has access to

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

Authorization

BearerAuth

Header parameters

Response

2004XX

Default Response

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

projectId*projectId (string)

The ID of a project

canUserWrite*boolean

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",
    "projectId": "text",
    "canUserWrite": false
  }
]

Create a new assets document

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

Authorization

BearerAuth

Header parameters

Body

application/json

name*string

description*string

type*any of

enumenum

Response

2004XX

Default Response

Body

application/json

assetsId*string

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "assetsId": "text"
}

Get the data of an assets document

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

Authorization

BearerAuth

Path parameters

assetsId*string

Header parameters

Response

2004XX

Default Response

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

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"
}

Patch the data of an assets document

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

Authorization

BearerAuth

Path parameters

assetsId*string

Header parameters

Response

2004XX

Default Response

Body

application/json

documentId*string

name*string

description*string

pictureUrl*string

type*any of

enumenum

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",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "text",
  "type": "Plugin"
}

Get all verisons for an assets document

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

Authorization

BearerAuth

Path parameters

assetsId*string

Header parameters

Response

2014XX

Default Response

Body

application/json

documentId*string

status*any of

enumenum

description*string

buildId*string

files*array of assetsVersionFile (object)

releaseobject

Release version information

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",
      "x-m2-project-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"
    },
    "createTimeMillis": 0
  }
]

Create a new verison for an assets document

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

Authorization

BearerAuth

Path parameters

assetsId*string

Header parameters

Body

application/json

description*string

buildId*string

releaseobject

Release version information

Response

2014XX

Default Response

Body

application/json

versionId*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/world-builder/assets/{assetsId}/{version}/', {
    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"
    }),
});
const data = await response.json();

Response

2014XX

{
  "versionId": "text"
}

Update an assets document version

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

Authorization

BearerAuth

Path parameters

assetsId*string

Header parameters

Body

application/json

statusany of

enumenum

descriptionstring

releaseobject

Release version information

Response

2014XX

Default Response

Body

application/json

documentId*string

status*any of

enumenum

description*string

buildId*string

files*array of assetsVersionFile (object)

releaseobject

Release version information

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",
      "x-m2-project-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"
  }
}

Retrieve upload URL for a new upload for an assets versions

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

Authorization

BearerAuth

Path parameters

assetsId*string

versionId*string

Header parameters

Body

application/json

name*string

sizeBytes*number

md5hash*string

Response

2004XX

Default Response

Body

application/json

uploadUrl*string

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "uploadUrl": "text"
}

Retrieve download info for an assets versions

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

Authorization

BearerAuth

Path parameters

assetsId*string

versionId*string

Header parameters

Response

2004XX

Default Response

Body

application/json

files*array of object

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "files": [
    {
      "name": "text",
      "sizeBytes": 0,
      "md5hash": "text",
      "downloadUrl": "text"
    }
  ]
}

Get the list of content IDs with a given org + project

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

Authorization

BearerAuth

Header parameters

Response

2004XX

Default Response

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 a new world builder content document

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

Default Response

Body

application/json

contentId*string

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 base URL, signed HTTP cookie & file metadata to download the world builder content for a deployment

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

Authorization

BearerAuth

Query parameters

Header parameters

Response

2004XX

Default Response

Body

application/json

files*array of object

baseUrl*string

cookie*string

pluginName*string

usePatching*boolean

modIdstring

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "files": [
    {
      "name": "text",
      "platform": "text",
      "configuration": "text",
      "sizeBytes": 0,
      "md5hash": "text",
      "type": "Pak",
      "downloadOptions": "text",
      "readOrder": 0,
      "downloadUrl": "text",
      "cookie": "text",
      "contentId": "text"
    }
  ],
  "baseUrl": "text",
  "cookie": "text",
  "pluginName": "text",
  "usePatching": false,
  "modId": "text"
}

Get the data of a specific content ID

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

Authorization

BearerAuth

Path parameters

contentId*string

Header parameters

Response

2004XX

Default Response

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"
}

Upload a map for a specific content ID

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

Authorization

BearerAuth

Path parameters

contentId*string

Header parameters

Body

application/json

maps*array of object

Response

2004XX

Default Response

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 a specific content ID

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

Authorization

BearerAuth

Path parameters

contentId*string

Header parameters

Response

2044XX

Default Response

Body

application/json

DeleteWorldBuilderContentResponse (null)

Empty 204 response

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
}

Generates signed GCS upload urls for uploading files for some content ID

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

Authorization

BearerAuth

Path parameters

contentId*string

Query parameters

Header parameters

Body

application/json

files*array of object

Response

2004XX

Default Response

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 the upload of world builder content files.

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

Authorization

BearerAuth

Path parameters

contentId*string

Header parameters

Body

application/json

modNamestring

modIdstring

Response

2004XX

Default Response

Body

application/json

modId*string

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 the list of mods that a user has access to within a given org

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

Authorization

BearerAuth

Header parameters

Response

2004XX

Default Response

Body

application/json

modId*string

name*string

description*string

pictureUrlstring

liveContentId*string

projectId*projectId (string)

The ID of a project

canUserWrite*boolean

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
  }
]

Get the list of mod IDs with a given org + project they have access to

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

Authorization

BearerAuth

Header parameters

Response

2004XX

Default Response

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 the list of mod IDs with a given org + project they have write access to

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

Authorization

BearerAuth

Path parameters

modId*string

Header parameters

Response

2004XX

Default Response

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
  },
  "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
    }
  ]
}

Gets the relevant asset manifests associated with a mod.

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

Path parameters

modId*string

Query parameters

Header parameters

Response

200

Default Response

Body

application/json

manifests*array of object

Request

JavaScriptCurlPython

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

Response

200

{
  "manifests": [
    {
      "url": "text",
      "cookie": "text",
      "platform": "text",
      "contentId": "text",
      "name": "text",
      "readOrder": 0,
      "sizeBytes": 0,
      "md5Hash": "text"
    }
  ]
}

Service health check

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

Response

200

Default Response

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

Get base URL, signed HTTP cookie & file metadata to download the world builder content for a deployment

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

Authorization

BearerAuth

Path parameters

deploymentId*string

Query parameters

Header parameters

Response

2004XX

Default Response

Body

application/json

files*array of object

baseUrl*string

cookie*string

pluginName*string

usePatching*boolean

modIdstring

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "files": [
    {
      "name": "text",
      "platform": "text",
      "configuration": "text",
      "sizeBytes": 0,
      "md5hash": "text",
      "type": "Pak",
      "downloadOptions": "text",
      "readOrder": 0,
      "downloadUrl": "text",
      "cookie": "text",
      "contentId": "text"
    }
  ],
  "baseUrl": "text",
  "cookie": "text",
  "pluginName": "text",
  "usePatching": false,
  "modId": "text"
}