Skip to main content
GET
/
marble
/
v1
/
worlds
/
{world_id}
Get World
curl --request GET \
  --url https://api.worldlabs.ai/marble/v1/worlds/{world_id} \
  --header 'WLT-Api-Key: <api-key>'
{
  "display_name": "<string>",
  "world_id": "<string>",
  "world_marble_url": "<string>",
  "assets": {
    "caption": "<string>",
    "imagery": {
      "pano_url": "<string>"
    },
    "mesh": {
      "collider_mesh_url": "<string>"
    },
    "splats": {
      "spz_urls": {}
    },
    "thumbnail_url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "model": "<string>",
  "permission": {
    "allowed_readers": [
      "<string>"
    ],
    "allowed_writers": [
      "<string>"
    ],
    "public": false
  },
  "tags": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "world_prompt": {
    "text_prompt": "<string>",
    "type": "text"
  }
}

Authorizations

​
WLT-Api-Key
string
header
required

API key for authentication. Get your key from the developer portal.

Path Parameters

​
world_id
string
required

Response

Successful Response

A generated world, including asset URLs.

​
display_name
string
required

Display name

​
world_id
string
required

World identifier

​
world_marble_url
string
required

World Marble URL

​
assets
WorldAssets · object

Generated world assets

​
created_at
string<date-time> | null

Creation timestamp

​
model
string | null

Model used for generation

​
permission
Permission · object

Access control permissions for the world

​
tags
string[] | null

Tags associated with the world

​
updated_at
string<date-time> | null

Last update timestamp

​
world_prompt
WorldTextPrompt · object

Input prompt class for text-conditioned world generation.