World Labs

App · 10 actions

Generate, export, and manage 3D Marble worlds and their media assets.

Actions

ActionWhat it does
Delete a worldDelete a world.
Export a worldExport a world.
Generate a worldGenerate a world.
Generate an RGB panorama from depthGenerate an RGB panorama from depth.
Get a media assetGet a media asset.
Get a worldGet a world.
Get credit balanceGet credit balance.
Get operation statusGet operation status.
List worldsList worlds.
Prepare a media uploadPrepare a media upload.

Delete a world

Delete a world.

Inputs

Worldworld_idtextRequired
World id.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "deleted": true,
    "world_id": "example"
  }
}

Export a world

Export a world.

Inputs

Worldworld_idtextRequired
World id.
Asset typeasset_typetextRequired
Asset family to export: 'splats' or 'mesh'.One of: splats, mesh.
FormatformattextRequired
Requested export format.One of: ply, glb.
Mesh variantmesh_varianttext
Mesh variant to return when an HQ mesh already exists.One of: textured, vertex_colored (Vertex colored).
Resolutionresolutiontext
Splat resolution to convert when exporting splats as PLY.One of: full_res (Full res), 500k, 150k, 100k.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "cost": {
      "line_items": [
        {
          "credits": 1,
          "name": "example"
        }
      ],
      "total_credits": 1
    },
    "created_at": "example",
    "done": true,
    "error": {
      "code": 1,
      "message": "example"
    },
    "expires_at": "example",
    "metadata": {},
    "operation_id": "example",
    "response": {
      "asset_type": "splats",
      "format": "ply",
      "mesh_variant": "textured",
      "resolution": "example",
      "url": "example"
    },
    "updated_at": "example"
  }
}

Generate a world

Generate a world.

Inputs

Display namedisplay_nametext
Optional human-readable title for the world (max 64 characters). Stored as world metadata and returned in world responses; does not affect generation. If omitted, World Labs may generate a title from the prompt.
Modelmodeltext
The model to use for generation. marble-1.1-plus includes dynamic world sizing. Legacy names ('Marble 0.1-plus', etc.) still work but are deprecated and will be removed in a future release.One of: marble-1.0-draft, marble-1.0, marble-1.1, marble-1.1-plus, Marble 0.1-mini, Marble 0.1-plus, Marble 1.1-plus.
Permissionpermissionobject
The permission for the world.
Seedseednumber
Random seed for generation.From 0.0 to 4294967295.0.
Tagstagslist
Optional tags for the world (max 10 tags, each up to 32 characters).
Text prompttext_prompttext
Describe the world to generate in plain text.
World promptworld_promptobject
Structured prompt for an image, video, or depth panorama.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "cost": {
      "line_items": [
        {
          "credits": 1,
          "name": "example"
        }
      ],
      "total_credits": 1
    },
    "created_at": "example",
    "done": true,
    "error": {
      "code": 1,
      "message": "example"
    },
    "expires_at": "example",
    "metadata": {},
    "operation_id": "example",
    "response": "example",
    "updated_at": "example"
  }
}

Generate an RGB panorama from depth

Generate an RGB panorama from depth.

Inputs

Depth pano imagedepth_pano_imageobjectRequired
Depth panorama image (EXR or PNG). Provide via URI, media_asset, or base64 (max 100 MB).
Seedseednumber
Random seed for reproducible generation.From 0.0 to 4294967295.0.
Text prompttext_prompttextRequired
Text description of the desired appearance.
Z maxz_maxnumber
Maximum depth. Required for PNG depth maps (normalized to [0, 1]). Must be provided together with z_min and must be greater than z_min. Omit for EXR depth maps.
Z minz_minnumber
Minimum depth. Required for PNG depth maps (normalized to [0, 1]). Must be provided together with z_max. Omit for EXR depth maps.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "cost": {
      "line_items": [
        {
          "credits": 1,
          "name": "example"
        }
      ],
      "total_credits": 1
    },
    "created_at": "example",
    "done": true,
    "error": {
      "code": 1,
      "message": "example"
    },
    "expires_at": "example",
    "metadata": {},
    "operation_id": "example",
    "response": {
      "pano_url": "example"
    },
    "updated_at": "example"
  }
}

Get a media asset

Get a media asset.

Inputs

Media asset IDmedia_asset_idtextRequired
Media asset id.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "created_at": "example",
    "extension": "example",
    "file_name": "example",
    "kind": "image",
    "media_asset_id": "example",
    "metadata": {},
    "updated_at": "example"
  }
}

Get a world

Get a world.

Inputs

Worldworld_idtextRequired
World id.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "assets": {
      "caption": "example",
      "imagery": {
        "pano_url": "example"
      },
      "mesh": {
        "collider_mesh_url": "example",
        "full_res_mesh_url": "example",
        "hq_mesh_url": "example"
      },
      "splats": {
        "semantics_metadata": {
          "ground_plane_offset": 1,
          "metric_scale_factor": 1
        },
        "spz_urls": {}
      },
      "thumbnail_url": "example"
    },
    "created_at": "example",
    "display_name": "example",
    "model": "example",
    "permission": {
      "allow_id_access": true,
      "allowed_readers": [
        "example"
      ],
      "allowed_writers": [
        "example"
      ],
      "public": true
    },
    "tags": [
      "example"
    ],
    "updated_at": "example",
    "world_id": "example",
    "world_marble_url": "example",
    "world_prompt": {
      "depth_pano_image": {
        "data_base64": "example",
        "extension": "example",
        "uri": "example"
      },
      "image_prompt": {
        "data_base64": "example",
        "extension": "example",
        "uri": "example"
      },
      "is_pano": true,
      "multi_image_prompt": [
        {
          "azimuth": 1,
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        }
      ],
      "pano_image": {
        "data_base64": "example",
        "extension": "example",
        "uri": "example"
      },
      "pano_mask": {
        "data_base64": "example",
        "extension": "example",
        "uri": "example"
      },
      "reconstruct_images": true,
      "text_prompt": "example",
      "type": "inpaint-pano",
      "video_prompt": {
        "data_base64": "example",
        "extension": "example",
        "uri": "example"
      },
      "z_max": 1,
      "z_min": 1
    }
  }
}

Get credit balance

Get credit balance.

Inputs

None.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "remaining_credits": 1
  }
}

Get operation status

Get operation status.

Inputs

Operation IDoperation_idtextRequired
Operation id.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "cost": {
      "line_items": [
        {
          "credits": 1,
          "name": "example"
        }
      ],
      "total_credits": 1
    },
    "created_at": "example",
    "done": true,
    "error": {
      "code": 1,
      "message": "example"
    },
    "expires_at": "example",
    "metadata": {},
    "operation_id": "example",
    "response": {
      "asset_type": "splats",
      "assets": {
        "caption": "example",
        "imagery": {
          "pano_url": "example"
        },
        "mesh": {
          "collider_mesh_url": "example",
          "full_res_mesh_url": "example",
          "hq_mesh_url": "example"
        },
        "splats": {
          "semantics_metadata": {},
          "spz_urls": {}
        },
        "thumbnail_url": "example"
      },
      "created_at": "example",
      "display_name": "example",
      "format": "ply",
      "mesh_variant": "textured",
      "model": "example",
      "pano_url": "example",
      "permission": {
        "allow_id_access": true,
        "allowed_readers": [
          "example"
        ],
        "allowed_writers": [
          "example"
        ],
        "public": true
      },
      "resolution": "example",
      "tags": [
        "example"
      ],
      "updated_at": "example",
      "url": "example",
      "world_id": "example",
      "world_marble_url": "example",
      "world_prompt": {
        "depth_pano_image": {
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        },
        "image_prompt": {
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        },
        "is_pano": true,
        "multi_image_prompt": [
          {}
        ],
        "pano_image": {
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        },
        "pano_mask": {
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        },
        "reconstruct_images": true,
        "text_prompt": "example",
        "type": "inpaint-pano",
        "video_prompt": {
          "data_base64": "example",
          "extension": "example",
          "uri": "example"
        },
        "z_max": 1,
        "z_min": 1
      }
    },
    "updated_at": "example"
  }
}

List worlds

List worlds.

Inputs

Created aftercreated_afterdate and time
Filter worlds created after this timestamp (inclusive).
Created beforecreated_beforedate and time
Filter worlds created before this timestamp (exclusive).
Is publicis_publictrue/false
Filter by visibility. true=public only, false=private only, null=all.
Modelmodeltext
Filter by model used for generation. Legacy names are deprecated; use the new lowercase names.One of: marble-1.0-draft, marble-1.0, marble-1.1, marble-1.1-plus, Marble 0.1-mini, Marble 0.1-plus, Marble 1.1-plus.
Page sizepage_sizenumber
Number of results per page (1-100).From 1.0 to 100.0.
Page tokenpage_tokentext
Cursor token for pagination (opaque base64 string from previous response). Use cursor from next_page_token in previous response for consistent pagination.
Sort bysort_bytext
Sort results by created_at or updated_at.One of: created_at (Created at), updated_at (Updated at).
Statusstatustext
Filter by world status.One of: SUCCEEDED, PENDING, FAILED, RUNNING.
Tagstagslist
Filter by tags (returns worlds with ANY of these tags).

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "next_page_token": "example",
    "worlds": [
      {
        "assets": {
          "caption": "example",
          "imagery": {},
          "mesh": {},
          "splats": {},
          "thumbnail_url": "example"
        },
        "created_at": "example",
        "display_name": "example",
        "model": "example",
        "permission": {
          "allow_id_access": true,
          "allowed_readers": [
            {}
          ],
          "allowed_writers": [
            {}
          ],
          "public": true
        },
        "tags": [
          "example"
        ],
        "updated_at": "example",
        "world_id": "example",
        "world_marble_url": "example",
        "world_prompt": {
          "depth_pano_image": {},
          "image_prompt": {},
          "is_pano": true,
          "multi_image_prompt": [
            {}
          ],
          "pano_image": {},
          "pano_mask": {},
          "reconstruct_images": true,
          "text_prompt": "example",
          "type": "inpaint-pano",
          "video_prompt": {},
          "z_max": 1,
          "z_min": 1
        }
      }
    ]
  }
}

Prepare a media upload

Prepare a media upload.

Inputs

Extensionextensiontext
File extension without dot.
File namefile_nametextRequired
File name.
Media kindmedia_kindtextRequired
High-level media type.One of: image, video.
Metadatametadataobject
Optional application-specific metadata.

Outputs

dataobject
The response from World Labs.
Example output
{
  "data": {
    "media_asset": {
      "created_at": "example",
      "extension": "example",
      "file_name": "example",
      "kind": "image",
      "media_asset_id": "example",
      "metadata": {},
      "updated_at": "example"
    },
    "upload_info": {
      "curl_example": "example",
      "required_headers": {},
      "upload_method": "example",
      "upload_url": "example"
    }
  }
}

On this page