/

List all worlds

get

Path parameters

projectIdstringRequired

The id of the project the world is in

Query parameters

offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

How many items to return at one time (max 100)

Responses

200

A paged array of worlds

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/worlds/{projectId}/web-world-instances/ HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "worlds": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "generalConfiguration": {
        "maxUserConnections": 1
      },
      "chatConfiguration": {
        "enabled": true
      },
      "authConfiguration": {
        "allowAnonymous": true,
        "password": "text",
        "authProviders": {
          "webhook": {
            "webhookUrl": "text"
          },
          "google": {
            "allowedOrganizations": [
              "text"
            ],
            "allowedUsers": [
              "text"
            ]
          },
          "discord": {
            "allowedUsers": [
              "text"
            ]
          }
        }
      },
      "mmlDocumentsConfiguration": {
        "mmlDocuments": {
          "ANY_ADDITIONAL_PROPERTY": {
            "url": "text",
            "position": {
              "x": 1,
              "y": 1,
              "z": 1
            },
            "rotation": {
              "x": 1,
              "y": 1,
              "z": 1
            },
            "scale": {
              "x": 1,
              "y": 1,
              "z": 1
            }
          }
        }
      },
      "environmentConfiguration": {
        "groundPlane": true,
        "skybox": {
          "intensity": 1,
          "blurriness": 1,
          "azimuthalAngle": 1,
          "polarAngle": 1
        },
        "envMap": {
          "intensity": 1
        },
        "sun": {
          "intensity": 1,
          "polarAngle": 1,
          "azimuthalAngle": 1
        },
        "postProcessing": {
          "bloomIntensity": 1
        },
        "ambientLight": {
          "intensity": 1
        }
      },
      "avatarConfiguration": {
        "availableAvatars": [
          {
            "isDefaultAvatar": true,
            "meshFileUrl": "text",
            "mmlCharacterString": null,
            "mmlCharacterUrl": null,
            "thumbnailUrl": "text",
            "name": "text"
          }
        ],
        "allowCustomAvatars": true,
        "customAvatarWebhookUrl": "text"
      },
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      },
      "url": "text",
      "enableTweakPane": true
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create a world

post

Path parameters

projectIdstringRequired

The id of the project the world is in

Body

application/json

namestringOptional

descriptionstringOptional

enableTweakPanebooleanOptional

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/worlds/{projectId}/web-world-instances/ HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 1043

{
  "name": "text",
  "description": "text",
  "generalConfiguration": {
    "maxUserConnections": 1
  },
  "mmlDocumentsConfiguration": {
    "mmlDocuments": {
      "ANY_ADDITIONAL_PROPERTY": {
        "url": "text",
        "position": {
          "x": 1,
          "y": 1,
          "z": 1
        },
        "rotation": {
          "x": 1,
          "y": 1,
          "z": 1
        },
        "scale": {
          "x": 1,
          "y": 1,
          "z": 1
        }
      }
    }
  },
  "authConfiguration": {
    "allowAnonymous": true,
    "password": "text",
    "authProviders": {
      "webhook": {
        "webhookUrl": "text"
      },
      "google": {
        "allowedOrganizations": [
          "text"
        ],
        "allowedUsers": [
          "text"
        ]
      },
      "discord": {
        "allowedUsers": [
          "text"
        ]
      }
    }
  },
  "chatConfiguration": {
    "enabled": true
  },
  "environmentConfiguration": {
    "groundPlane": true,
    "skybox": {
      "intensity": 1,
      "blurriness": 1,
      "azimuthalAngle": 1,
      "polarAngle": 1
    },
    "envMap": {
      "intensity": 1
    },
    "sun": {
      "intensity": 1,
      "polarAngle": 1,
      "azimuthalAngle": 1
    },
    "postProcessing": {
      "bloomIntensity": 1
    },
    "ambientLight": {
      "intensity": 1
    }
  },
  "avatarConfiguration": {
    "availableAvatars": [
      {
        "isDefaultAvatar": true,
        "meshFileUrl": "text",
        "mmlCharacterString": null,
        "mmlCharacterUrl": null,
        "thumbnailUrl": "text",
        "name": "text"
      }
    ],
    "allowCustomAvatars": true,
    "customAvatarWebhookUrl": "text"
  },
  "enableTweakPane": true
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "generalConfiguration": {
    "maxUserConnections": 1
  },
  "chatConfiguration": {
    "enabled": true
  },
  "authConfiguration": {
    "allowAnonymous": true,
    "password": "text",
    "authProviders": {
      "webhook": {
        "webhookUrl": "text"
      },
      "google": {
        "allowedOrganizations": [
          "text"
        ],
        "allowedUsers": [
          "text"
        ]
      },
      "discord": {
        "allowedUsers": [
          "text"
        ]
      }
    }
  },
  "mmlDocumentsConfiguration": {
    "mmlDocuments": {
      "ANY_ADDITIONAL_PROPERTY": {
        "url": "text",
        "position": {
          "x": 1,
          "y": 1,
          "z": 1
        },
        "rotation": {
          "x": 1,
          "y": 1,
          "z": 1
        },
        "scale": {
          "x": 1,
          "y": 1,
          "z": 1
        }
      }
    }
  },
  "environmentConfiguration": {
    "groundPlane": true,
    "skybox": {
      "intensity": 1,
      "blurriness": 1,
      "azimuthalAngle": 1,
      "polarAngle": 1
    },
    "envMap": {
      "intensity": 1
    },
    "sun": {
      "intensity": 1,
      "polarAngle": 1,
      "azimuthalAngle": 1
    },
    "postProcessing": {
      "bloomIntensity": 1
    },
    "ambientLight": {
      "intensity": 1
    }
  },
  "avatarConfiguration": {
    "availableAvatars": [
      {
        "isDefaultAvatar": true,
        "meshFileUrl": "text",
        "mmlCharacterString": null,
        "mmlCharacterUrl": null,
        "thumbnailUrl": "text",
        "name": "text"
      }
    ],
    "allowCustomAvatars": true,
    "customAvatarWebhookUrl": "text"
  },
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  },
  "url": "text",
  "enableTweakPane": true
}