Sign in

v1

latestOpenAPI 3.1.02026-07-26104450.2 KB

List Worlds

List worlds with optional filters.

Returns worlds created through the API with optional filtering and pagination.

Args: request: List request with optional filters: - page_size: Number of results per page (default: 10) - page_token: Pagination token from previous response - status: Filter by status (e.g., "COMPLETED") - model: Filter by model name (e.g., "marble-1.0-plus") - tags: Filter by tags (matches worlds with any tag) - is_public: Filter by visibility (true=public, false=private, null=all) - created_after: Filter by creation time (after timestamp) - created_before: Filter by creation time (before timestamp) - sort_by: Sort order ("created_at" or "updated_at")

Returns: ListWorldsResponse with worlds list and next_page_token for pagination.

Raises: HTTPException: 400 if invalid parameters HTTPException: 500 if request fails

post/marble/v1/worlds:list

Request body

created_afterstring date-time nullable

Filter worlds created after this timestamp (inclusive)

created_beforestring date-time nullable

Filter worlds created before this timestamp (exclusive)

is_publicboolean nullable

Filter by visibility. true=public only, false=private only, null=all

page_sizeinteger

Number of results per page (1-100)

page_tokenstring nullable

Cursor token for pagination (opaque base64 string from previous response). Use cursor from next_page_token in previous response for consistent pagination.

sort_by'created_at' | 'updated_at'

Sort results by created_at or updated_at

status'SUCCEEDED' | 'PENDING' | 'FAILED' | 'RUNNING' nullable

Filter by world status

tagsstring[] nullable

Filter by tags (returns worlds with ANY of these tags)

Example request

{
  "model": "marble-1.0",
  "page_size": 20,
  "sort_by": "created_at",
  "status": "SUCCEEDED"
}

Response

Successful Response

next_page_tokenstring nullable

Token for fetching the next page of results

Example response

{
  "worlds": [
    {
      "world_prompt": {
        "image_prompt": {
          "extension": "jpg"
        }
      }
    }
  ]
}