Operations

Get an operation

Get an operation by ID.

Poll this endpoint to check the status of a long-running operation. When done=true, the response field contains the generated world.

Args: operation_id: The operation identifier from /worlds:generate.

Returns: GetOperationResponse[World] with:

operation_id: Operation identifier
created_at: Creation timestamp
updated_at: Last update timestamp
expires_at: Expiration timestamp
done: true when complete, false while in progress
error: Error details if failed, null otherwise
metadata: Progress information and world_id
response: Generated World if done=true, null otherwise

Raises: HTTPException: 401 if unauthorized HTTPException: 404 if operation not found HTTPException: 500 if request fails

GET

marble

operations

{operation_id}

Get Operation

curl --request GET \
  --url https://api.worldlabs.ai/marble/v1/operations/{operation_id} \
  --header 'WLT-Api-Key: <api-key>'

{
  "done": true,
  "operation_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "error": {
    "code": 123,
    "message": "<string>"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "response": {
    "display_name": "<string>",
    "world_id": "<string>",
    "world_marble_url": "<string>",
    "assets": {
      "caption": "<string>",
      "imagery": {
        "pano_url": "<string>"
      },
      "mesh": {
        "collider_mesh_url": "<string>"
      },
      "splats": {
        "semantics_metadata": {
          "ground_plane_offset": 123,
          "metric_scale_factor": 123
        },
        "spz_urls": {}
      },
      "thumbnail_url": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "model": "<string>",
    "permission": {
      "allow_id_access": false,
      "allowed_readers": [
        "<string>"
      ],
      "allowed_writers": [
        "<string>"
      ],
      "public": false
    },
    "tags": [
      "<string>"
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "world_prompt": {
      "text_prompt": "<string>",
      "type": "text"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

WLT-Api-Key

string

header

required

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

Path Parameters

operation_id

string

required

Response

Successful Response

done

boolean

required

True if the operation is completed

operation_id

string

required

Operation identifier

created_at

string<date-time> | null

Creation timestamp

error

OperationError · object

Error information if the operation failed

Show child attributes

expires_at

string<date-time> | null

Expiration timestamp

metadata

Metadata · object

Service-specific metadata, such as progress percentage

response

World · object

A generated world, including asset URLs.

World
PanoDepthToRgbResult

Show child attributes

updated_at

string<date-time> | null

Last update timestamp

OverviewCheck the API credit balance for the authenticated account.

⌘I

Get Operation

curl --request GET \
  --url https://api.worldlabs.ai/marble/v1/operations/{operation_id} \
  --header 'WLT-Api-Key: <api-key>'

{
  "done": true,
  "operation_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "error": {
    "code": 123,
    "message": "<string>"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "response": {
    "display_name": "<string>",
    "world_id": "<string>",
    "world_marble_url": "<string>",
    "assets": {
      "caption": "<string>",
      "imagery": {
        "pano_url": "<string>"
      },
      "mesh": {
        "collider_mesh_url": "<string>"
      },
      "splats": {
        "semantics_metadata": {
          "ground_plane_offset": 123,
          "metric_scale_factor": 123
        },
        "spz_urls": {}
      },
      "thumbnail_url": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "model": "<string>",
    "permission": {
      "allow_id_access": false,
      "allowed_readers": [
        "<string>"
      ],
      "allowed_writers": [
        "<string>"
      ],
      "public": false
    },
    "tags": [
      "<string>"
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "world_prompt": {
      "text_prompt": "<string>",
      "type": "text"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}