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.
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.
The ID of an organization
The ID of a project
List of content IDs available in World Builder, representing unique identifiers for various content items
List of content IDs available in World Builder, representing unique identifiers for various content items
The error object returned by the API when an error occurs
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"
]Creates new content for a specific project.
The ID of an organization
The ID of a project
Data required to create new World Builder content, excluding system-generated fields. This includes content details such as description, buildId, pluginName, and maps.
Response containing the ID of the newly created content in World Builder
The error object returned by the API when an error occurs
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"
}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).
Number of documents to return per page
Unique id of the returned value object that the query should start after
Unique id of the returned value object that the query should end before
The ID of an organization
List of embedded content runs
The error object returned by the API when an error occurs
GET /api/world-builder/content/embed/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}
]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
The ID of an organization
The ID of a project
Detailed information about a specific World Builder content
Detailed information about a specific World Builder content
The error object returned by the API when an error occurs
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
}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
The ID of an organization
The ID of a project
Data for updating maps in specific World Builder content, allowing partial updates
Updated World Builder content after modification, including organization, project, and mod IDs
The error object returned by the API when an error occurs
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"
}Deletes a specific content ID.
Unique identifier of the World Builder content to operate on, used in various content-related API endpoints
The ID of an organization
The ID of a project
Empty response indicating successful content deletion
Empty response indicating successful content deletion
The error object returned by the API when an error occurs
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
Queues a new content embed run for the specified organization, project, and content.
The ID of an organization
The ID of a project
The request body for embedding content
The title ID of the variant to use for embedding
The data of the created content embed run
The error object returned by the API when an error occurs
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"
}Stops a content embed run that is in the queued, pending, or running phase.
The ID of an organization
The ID of a project
Default Response
The error object returned by the API when an error occurs
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
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.
Number of documents to return per page
Unique id of the returned value object that the query should start after
Unique id of the returned value object that the query should end before
The ID of an organization
The ID of a project
The relevant mods associated with the organization.
The relevant mods associated with the organization.
The error object returned by the API when an error occurs
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"
}Retrieves a list of mod IDs that the user has access to within an organization and project.
The ID of an organization
The ID of a project
The relevant mods associated with the project.
The error object returned by the API when an error occurs
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"
}
}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.
Number of documents to return per page
Unique id of the returned value object that the query should start after
Unique id of the returned value object that the query should end before
The ID of an organization
The ID of a project
The response when getting a mod
The error object returned by the API when an error occurs
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
}
]
}Lists all the contents for a mod.
Number of documents to return per page
Unique id of the returned value object that the query should start after
Unique id of the returned value object that the query should end before
The ID of an organization
The ID of a project
A list of contents for the requested Mod.
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: */*
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"
}Last updated
Was this helpful?