@tanstack/ai-worldlabs 0.0.0 → 0.1.2

package/src/generated/sdk.gen.ts

@@ -0,0 +1,531 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type {
+  Client,
+  ClientMeta,
+  Options as Options2,
+  RequestResult,
+  TDataShape,
+} from './client'
+import { client } from './client.gen'
+import type {
+  DeleteWorldMarbleV1WorldsWorldIdDeleteData,
+  DeleteWorldMarbleV1WorldsWorldIdDeleteErrors,
+  DeleteWorldMarbleV1WorldsWorldIdDeleteResponses,
+  ExportWorldMarbleV1WorldsWorldIdExportPostData,
+  ExportWorldMarbleV1WorldsWorldIdExportPostErrors,
+  ExportWorldMarbleV1WorldsWorldIdExportPostResponses,
+  GenerateWorldMarbleV1WorldsGeneratePostData,
+  GenerateWorldMarbleV1WorldsGeneratePostErrors,
+  GenerateWorldMarbleV1WorldsGeneratePostResponses,
+  GetCreditsMarbleV1CreditsGetData,
+  GetCreditsMarbleV1CreditsGetResponses,
+  GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetData,
+  GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetErrors,
+  GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetResponses,
+  GetOperationMarbleV1OperationsOperationIdGetData,
+  GetOperationMarbleV1OperationsOperationIdGetErrors,
+  GetOperationMarbleV1OperationsOperationIdGetResponses,
+  GetWorldMarbleV1WorldsWorldIdGetData,
+  GetWorldMarbleV1WorldsWorldIdGetErrors,
+  GetWorldMarbleV1WorldsWorldIdGetResponses,
+  ListWorldsMarbleV1WorldsListPostData,
+  ListWorldsMarbleV1WorldsListPostErrors,
+  ListWorldsMarbleV1WorldsListPostResponses,
+  PanoDepthToRgbMarbleV1PanoDepthToRgbPostData,
+  PanoDepthToRgbMarbleV1PanoDepthToRgbPostErrors,
+  PanoDepthToRgbMarbleV1PanoDepthToRgbPostResponses,
+  PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostData,
+  PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostErrors,
+  PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostResponses,
+} from './types.gen'
+
+export type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+  TResponse = unknown,
+> = Options2<TData, ThrowOnError, TResponse> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta
+}
+
+/**
+ * Get Credits
+ *
+ * Get remaining API credits for the authenticated user.
+ *
+ * Returns:
+ * CreditsResponse with the current aggregate API credit balance.
+ *
+ * Raises:
+ * HTTPException: 404 if the caller is not an API-enabled user
+ * HTTPException: 503 if the billing backend is unavailable
+ */
+export const getCreditsMarbleV1CreditsGet = <
+  ThrowOnError extends boolean = false,
+>(
+  options?: Options<GetCreditsMarbleV1CreditsGetData, ThrowOnError>,
+): RequestResult<
+  GetCreditsMarbleV1CreditsGetResponses,
+  unknown,
+  ThrowOnError
+> =>
+  (options?.client ?? client).get<
+    GetCreditsMarbleV1CreditsGetResponses,
+    unknown,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/credits',
+    ...options,
+  })
+
+/**
+ * Get Media Asset
+ *
+ * Get a media asset by ID.
+ *
+ * Retrieves metadata for a previously created media asset.
+ *
+ * Args:
+ * media_asset_id: The media asset identifier.
+ *
+ * Returns:
+ * MediaAsset object with media_asset_id, file_name, extension, kind,
+ * metadata, created_at, and updated_at.
+ *
+ * Raises:
+ * HTTPException: 404 if not found
+ */
+export const getMediaAssetMarbleV1MediaAssetsMediaAssetIdGet = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<
+    GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetData,
+    ThrowOnError
+  >,
+): RequestResult<
+  GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetResponses,
+  GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).get<
+    GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetResponses,
+    GetMediaAssetMarbleV1MediaAssetsMediaAssetIdGetErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/media-assets/{media_asset_id}',
+    ...options,
+  })
+
+/**
+ * Prepare a media asset upload
+ *
+ * Prepare a media asset upload for use in world generation.
+ *
+ * This API endpoint creates a media asset record and returns a signed upload URL.
+ * Use this workflow to upload images or videos that you want to reference in world
+ * generation requests.
+ *
+ * ## Workflow
+ *
+ * 1. **Prepare Upload** (this endpoint): Get a `media_asset_id` and `upload_url`
+ * 2. **Upload File**: Use the signed URL to upload your file
+ * 3. **Generate World**: Reference the `media_asset_id` in `/worlds:generate` with
+ * source type "media_asset"
+ *
+ * ## Request Parameters
+ *
+ * - `file_name`: Your file's name (e.g., "landscape.jpg")
+ * - `extension`: File extension without dot (e.g., "jpg", "png", "mp4")
+ * - `kind`: Either "image" or "video"
+ * - `metadata`: Optional custom metadata object
+ *
+ * ## Response
+ *
+ * Returns a `MediaAssetPrepareUploadResponse` containing:
+ *
+ * - `media_asset`: Object with `media_asset_id` (use this in world generation)
+ * - `upload_info`: Object with `upload_url`, `required_headers`, and `curl_example`
+ *
+ * ## Uploading Your File
+ *
+ * Use the returned `upload_url` and `required_headers` to upload your file:
+ *
+ * ```bash
+ * curl --request PUT \
+ * --url <upload_url> \
+ * --header "Content-Type: <content-type>" \
+ * --header "<header-name>: <header-value>" \
+ * --upload-file /path/to/your/file
+ * ```
+ *
+ * Replace:
+ * - `<upload_url>`: The `upload_url` from the response
+ * - `<content-type>`: MIME type (e.g., `image/png`, `image/jpeg`, `video/mp4`)
+ * - `<header-name>: <header-value>`: Each header from `required_headers`
+ * - `/path/to/your/file`: Path to your local file
+ *
+ * ## Example Usage in World Generation
+ *
+ * After uploading, use the `media_asset_id` in a world generation request:
+ *
+ * ```json
+ * {
+ * "world_prompt": {
+ * "type": "image",
+ * "image_prompt": {
+ * "source": "media_asset",
+ * "media_asset_id": "<your-media-asset-id>"
+ * }
+ * }
+ * }
+ * ```
+ */
+export const prepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPost = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<
+    PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostData,
+    ThrowOnError
+  >,
+): RequestResult<
+  PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostResponses,
+  PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).post<
+    PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostResponses,
+    PrepareMediaAssetUploadMarbleV1MediaAssetsPrepareUploadPostErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/media-assets:prepare_upload',
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers,
+    },
+  })
+
+/**
+ * Get 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
+ * - cost: Settled credit cost breakdown; populated only when the
+ * operation completed successfully (done=true with no error)
+ * and a public price is known for its operation type. Failed
+ * or in-progress operations return null.
+ *
+ * Raises:
+ * HTTPException: 401 if unauthorized
+ * HTTPException: 404 if operation not found
+ * HTTPException: 500 if request fails
+ */
+export const getOperationMarbleV1OperationsOperationIdGet = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<
+    GetOperationMarbleV1OperationsOperationIdGetData,
+    ThrowOnError
+  >,
+): RequestResult<
+  GetOperationMarbleV1OperationsOperationIdGetResponses,
+  GetOperationMarbleV1OperationsOperationIdGetErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).get<
+    GetOperationMarbleV1OperationsOperationIdGetResponses,
+    GetOperationMarbleV1OperationsOperationIdGetErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/operations/{operation_id}',
+    ...options,
+  })
+
+/**
+ * Pano Depth To Rgb
+ *
+ * Generate an RGB panorama from a depth panorama.
+ *
+ * Provide a depth panorama and a text prompt
+ * describing the desired appearance. The depth map
+ * supplies the scene geometry; the model synthesizes
+ * textures that match that geometry and returns a
+ * panoramic RGB image.
+ *
+ * Accepted depth inputs:
+ *
+ * * **EXR**: float depth values. Omit
+ * ``z_min`` and ``z_max``.
+ * * **PNG**: depth values normalized to [0, 1].
+ * Provide both ``z_min`` and ``z_max`` so the
+ * service can decode the PNG correctly.
+ *
+ * For a complete PNG-based workflow, see the
+ * [web-chisel-depth-png example](https://github.com/worldlabsai/worldlabs-api-examples/tree/main/web-chisel-depth-png).
+ *
+ * Returns a long-running ``Operation``. Poll
+ * ``GET /operations/{operation_id}`` until
+ * ``done`` is ``true``, then read the generated
+ * panorama URL from ``response.pano_url``.
+ *
+ * Raises:
+ * HTTPException: 400 if invalid request
+ * HTTPException: 402 if insufficient credits
+ * HTTPException: 500 if generation could not start
+ */
+export const panoDepthToRgbMarbleV1PanoDepthToRgbPost = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<PanoDepthToRgbMarbleV1PanoDepthToRgbPostData, ThrowOnError>,
+): RequestResult<
+  PanoDepthToRgbMarbleV1PanoDepthToRgbPostResponses,
+  PanoDepthToRgbMarbleV1PanoDepthToRgbPostErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).post<
+    PanoDepthToRgbMarbleV1PanoDepthToRgbPostResponses,
+    PanoDepthToRgbMarbleV1PanoDepthToRgbPostErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/pano:depth_to_rgb',
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers,
+    },
+  })
+
+/**
+ * Delete World
+ *
+ * Delete a world by ID.
+ *
+ * Permanently deletes a world and its associated assets.
+ * Only the world owner can delete a world.
+ *
+ * Args:
+ * world_id: The unique identifier of the world to delete.
+ *
+ * Returns:
+ * DeleteWorldResponse confirming the deletion.
+ *
+ * Raises:
+ * HTTPException: 403 if user is not the world owner
+ * HTTPException: 404 if world not found
+ * HTTPException: 500 if deletion fails
+ */
+export const deleteWorldMarbleV1WorldsWorldIdDelete = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<DeleteWorldMarbleV1WorldsWorldIdDeleteData, ThrowOnError>,
+): RequestResult<
+  DeleteWorldMarbleV1WorldsWorldIdDeleteResponses,
+  DeleteWorldMarbleV1WorldsWorldIdDeleteErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).delete<
+    DeleteWorldMarbleV1WorldsWorldIdDeleteResponses,
+    DeleteWorldMarbleV1WorldsWorldIdDeleteErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/worlds/{world_id}',
+    ...options,
+  })
+
+/**
+ * Get World
+ *
+ * Get a world by ID.
+ *
+ * Retrieves a world's details including generated assets if available.
+ * Only the world owner or users with access to public worlds can retrieve them.
+ *
+ * Args:
+ * world_id: The unique identifier of the world.
+ *
+ * Returns:
+ * World object with world_id, display_name, tags, assets, created_at,
+ * updated_at, permission, model, world_prompt, and world_marble_url.
+ *
+ * Raises:
+ * HTTPException: 404 if world not found or access denied
+ */
+export const getWorldMarbleV1WorldsWorldIdGet = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<GetWorldMarbleV1WorldsWorldIdGetData, ThrowOnError>,
+): RequestResult<
+  GetWorldMarbleV1WorldsWorldIdGetResponses,
+  GetWorldMarbleV1WorldsWorldIdGetErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).get<
+    GetWorldMarbleV1WorldsWorldIdGetResponses,
+    GetWorldMarbleV1WorldsWorldIdGetErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/worlds/{world_id}',
+    ...options,
+  })
+
+/**
+ * Export World
+ *
+ * Export a generated world asset.
+ *
+ * PLY splat exports are converted synchronously, cached in GCS, and returned
+ * as completed operations. HQ mesh exports reuse the existing async mesh
+ * export service and return an in-progress operation.
+ */
+export const exportWorldMarbleV1WorldsWorldIdExportPost = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<
+    ExportWorldMarbleV1WorldsWorldIdExportPostData,
+    ThrowOnError
+  >,
+): RequestResult<
+  ExportWorldMarbleV1WorldsWorldIdExportPostResponses,
+  ExportWorldMarbleV1WorldsWorldIdExportPostErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).post<
+    ExportWorldMarbleV1WorldsWorldIdExportPostResponses,
+    ExportWorldMarbleV1WorldsWorldIdExportPostErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/worlds/{world_id}:export',
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers,
+    },
+  })
+
+/**
+ * Generate World
+ *
+ * Start world generation.
+ *
+ * Creates a new world generation job and returns a long-running operation.
+ * Poll the /operations/{operation_id} endpoint to check generation status
+ * and retrieve the generated world when complete.
+ *
+ * Args:
+ * request: The world generation request containing world_prompt, display_name,
+ * tags, model, seed, and permission settings.
+ *
+ * Returns:
+ * GenerateWorldResponse with operation_id and timestamps. Use the operation_id
+ * to poll for completion.
+ *
+ * Raises:
+ * HTTPException: 400 if invalid request or content violates policies
+ * HTTPException: 402 if insufficient credits
+ * HTTPException: 500 if generation could not be started
+ */
+export const generateWorldMarbleV1WorldsGeneratePost = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<GenerateWorldMarbleV1WorldsGeneratePostData, ThrowOnError>,
+): RequestResult<
+  GenerateWorldMarbleV1WorldsGeneratePostResponses,
+  GenerateWorldMarbleV1WorldsGeneratePostErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).post<
+    GenerateWorldMarbleV1WorldsGeneratePostResponses,
+    GenerateWorldMarbleV1WorldsGeneratePostErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/worlds:generate',
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers,
+    },
+  })
+
+/**
+ * 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
+ */
+export const listWorldsMarbleV1WorldsListPost = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<ListWorldsMarbleV1WorldsListPostData, ThrowOnError>,
+): RequestResult<
+  ListWorldsMarbleV1WorldsListPostResponses,
+  ListWorldsMarbleV1WorldsListPostErrors,
+  ThrowOnError
+> =>
+  (options.client ?? client).post<
+    ListWorldsMarbleV1WorldsListPostResponses,
+    ListWorldsMarbleV1WorldsListPostErrors,
+    ThrowOnError
+  >({
+    security: [{ name: 'WLT-Api-Key', type: 'apiKey' }],
+    url: '/marble/v1/worlds:list',
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers,
+    },
+  })