World Builder

Controls the creation and management of World Builder content and mods. It interfaces with the Unreal Engine editor to customize cooking, packaging, and deployment for both game clients and servers.

Get Content IDs

get

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.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

200

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

application/json

string[]Optional

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

4XX

The error object returned by the API when an error occurs

application/json

get

/content/

HTTPcURLJavaScriptPython

GET /api/world-builder/content/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

[
  "text"
]

Create Content

post

Creates new content for a specific project.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Body

application/json

Data required to create new World Builder content, excluding system-generated fields. This includes content details such as description, buildId, pluginName, and maps.

descriptionstringRequired

buildIdstringRequired

pluginNamestringRequired

patchTypeany ofOptional

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

Responses

201

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

application/json

4XX

The error object returned by the API when an error occurs

application/json

post

/content/

HTTPcURLJavaScriptPython

POST /api/world-builder/content/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 343

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

{
  "contentId": "text"
}

List Embedded Content Runs

get

Retrieves a list of runs for uploading embedded content for the specified organization. It can filter the runs by state (queued, pending, running, cancelling, completed or failed).

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Query parameters

limitnumberOptional

Number of documents to return per page

startAfterstringOptional

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

endBeforestringOptional

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

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

Responses

200

List of embedded content runs

application/json

List of embedded content runs

organizationIdstringRequired

The ID of an organization

projectIdstringRequired

The ID of a project

contentIdstringRequired

gfnTitleIdstringRequired

GFN Title ID of the variant into which we want to embed the content

createdBystringRequired

The ID of the user who created the Fast Play build

buildkiteRunIdstringOptional

A unique identifier for the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase.

buildkiteRunNumbernumberOptional

The number of the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase. We use this as a query parameter when cancelling a Buildkite run.

startTimeMsnumberOptional

The time the Fast Play Buildkite run started, in ms. It coincides with the embed run being moved to the 'pending' phase.

endTimeMsnumberOptional

The time the Fast Play Buildkite run ended (successfully or not), in ms. It coincides with the embed run being moved to the 'completed' or 'failed' phase.

idstringRequired

4XX

The error object returned by the API when an error occurs

application/json

get

/content/embed/

HTTPcURLJavaScriptPython

GET /api/world-builder/content/embed/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Accept: */*

[
  {
    "organizationId": "text",
    "projectId": "text",
    "contentId": "text",
    "status": {
      "phase": "Queued",
      "message": "text"
    },
    "gfnTitleId": "text",
    "createdBy": "text",
    "buildkiteRunId": "text",
    "buildkiteRunNumber": 1,
    "startTimeMs": 1,
    "endTimeMs": 1,
    "resolvedIds": {
      "modId": "text",
      "buildId": "text"
    },
    "createdContentIds": {
      "buildId": "text",
      "contentId": "text"
    },
    "id": "text"
  }
]

Get Content

get

Retrieves the data for content using its contentId.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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-idstringOptional

The ID of an organization

x-m2-project-idstringOptional

The ID of a project

Responses

200

Detailed information about a specific World Builder content

application/json

Detailed information about a specific World Builder content

4XX

The error object returned by the API when an error occurs

application/json

get

/content/{contentId}/

HTTPcURLJavaScriptPython

GET /api/world-builder/content/{contentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "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": 1,
      "md5hash": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "type": "Pak"
    }
  ],
  "patchType": "None",
  "organizationId": "text",
  "projectId": "text",
  "modId": "text",
  "contentVersionCount": 1
}

Update Content

patch

Updates the maps for a specific content ID.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

application/json

Data for updating maps in specific World Builder content, allowing partial updates

Responses

200

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

application/json

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

documentIdstringRequired

descriptionstringRequired

statusany ofRequired

number · enumOptionalPossible values:

or

number · enumOptionalPossible values:

buildIdstringRequired

creatorIdstringRequired

pluginNamestringRequired

patchTypeany ofOptional

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

4XX

The error object returned by the API when an error occurs

application/json

patch

/content/{contentId}/

HTTPcURLJavaScriptPython

PATCH /api/world-builder/content/{contentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "maps": [
    {
      "name": "text",
      "longPackageName": "text",
      "description": "text",
      "pictureUrl": "text",
      "roles": [
        "text"
      ]
    }
  ]
}

{
  "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": 1,
      "md5hash": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "type": "Pak"
    }
  ],
  "patchType": "None"
}

Delete Content

delete

Deletes a specific content ID.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

204

Empty response indicating successful content deletion

application/json

4XX

The error object returned by the API when an error occurs

application/json

delete

/content/{contentId}/

HTTPcURLJavaScriptPython

DELETE /api/world-builder/content/{contentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Create a new Fast Play build

post

Queues a new Fast Play build for the specified organization, project, and content.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Path parameters

contentIdstringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Body

application/json

The request body for embedding content

gfnTitleIdstringRequired

The title ID of the variant to use for embedding

Responses

200

The data of the created Fast Play build

application/json

The data of the created Fast Play build

organizationIdstringRequired

The ID of an organization

projectIdstringRequired

The ID of a project

contentIdstringRequired

gfnTitleIdstringRequired

GFN Title ID of the variant into which we want to embed the content

createdBystringRequired

The ID of the user who created the Fast Play build

buildkiteRunIdstringOptional

A unique identifier for the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase.

buildkiteRunNumbernumberOptional

The number of the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase. We use this as a query parameter when cancelling a Buildkite run.

startTimeMsnumberOptional

The time the Fast Play Buildkite run started, in ms. It coincides with the embed run being moved to the 'pending' phase.

endTimeMsnumberOptional

The time the Fast Play Buildkite run ended (successfully or not), in ms. It coincides with the embed run being moved to the 'completed' or 'failed' phase.

idstringRequired

4XX

The error object returned by the API when an error occurs

application/json

post

/content/{contentId}/embed/

HTTPcURLJavaScriptPython

POST /api/world-builder/content/{contentId}/embed/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "gfnTitleId": "text"
}

{
  "organizationId": "text",
  "projectId": "text",
  "contentId": "text",
  "status": {
    "phase": "Queued",
    "message": "text"
  },
  "gfnTitleId": "text",
  "createdBy": "text",
  "buildkiteRunId": "text",
  "buildkiteRunNumber": 1,
  "startTimeMs": 1,
  "endTimeMs": 1,
  "resolvedIds": {
    "modId": "text",
    "buildId": "text"
  },
  "createdContentIds": {
    "buildId": "text",
    "contentId": "text"
  },
  "id": "text"
}

Delete a Fast Play build

delete

Stops a Fast Play build that is in the queued, pending, or running phase.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Path parameters

contentIdstringRequired

contentEmbedRunIdstringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

204

Default Response

application/json

4XX

The error object returned by the API when an error occurs

application/json

delete

/content/{contentId}/embed/{contentEmbedRunId}/

HTTPcURLJavaScriptPython

DELETE /api/world-builder/content/{contentId}/embed/{contentEmbedRunId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Get Mods

get

Retrieves a list of mods that the user has access to within an organization or project. Only project scoped queries may make paginated requests. Support for organization scoped queries will be removed in a future version.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Query parameters

limitnumberOptional

Number of documents to return per page

startAfterstringOptional

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

endBeforestringOptional

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

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringOptional

The ID of a project

Responses

200

The relevant mods associated with the organization.

application/json

The relevant mods associated with the organization.

or

4XX

The error object returned by the API when an error occurs

application/json

get

/mods/

HTTPcURLJavaScriptPython

GET /api/world-builder/mods/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Accept: */*

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

Get Mod IDs

get

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

200

The relevant mods associated with the project.

application/json

The relevant mods associated with the project.

4XX

The error object returned by the API when an error occurs

application/json

get

/mods/mapping/

HTTPcURLJavaScriptPython

GET /api/world-builder/mods/mapping/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

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

Get Mod

get

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.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Path parameters

modIdstringRequired

Query parameters

limitnumberOptional

Number of documents to return per page

startAfterstringOptional

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

endBeforestringOptional

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

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

200

The response when getting a mod

application/json

The response when getting a mod

4XX

The error object returned by the API when an error occurs

application/json

get

/mods/{modId}/

HTTPcURLJavaScriptPython

GET /api/world-builder/mods/{modId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

{
  "mod": {
    "modId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "liveContentId": "text",
    "canUserWrite": true,
    "lastUploadTime": 1,
    "modContentCount": 1
  },
  "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": 1,
          "md5hash": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "type": "Pak"
        }
      ],
      "patchType": "None",
      "createTimeMillis": 1
    }
  ]
}

Get Mod Contents

get

Lists all the contents for a mod.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Path parameters

modIdstringRequired

Query parameters

limitnumberOptional

Number of documents to return per page

startAfterstringOptional

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

endBeforestringOptional

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

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

200

A list of contents for the requested Mod.

application/json

A list of contents for the requested Mod.

hasMorestringOptional

get

/mods/{modId}/contents/

HTTPcURLJavaScriptPython

GET /api/world-builder/mods/{modId}/contents/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

200

A list of contents for the requested Mod.

{
  "contents": [
    {
      "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": 1,
          "md5hash": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "type": "Pak"
        }
      ],
      "patchType": "None",
      "createTimeMillis": 1,
      "contentId": "text",
      "contentNumber": 1
    }
  ],
  "hasMore": "text"
}