Skip to content

Latest commit

 

History

History
154 lines (105 loc) · 12 KB

README.md

File metadata and controls

154 lines (105 loc) · 12 KB
Raw

ThreeDModelAssets

(threeDModelAssets)

Overview

Available Operations

delete3DModelById

This endpoint deletes the specific 3D Model

Example Usage

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.threeDModelAssets.delete3DModelById("<id>");

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
import { threeDModelAssetsDelete3DModelById } from "@leonardo-ai/sdk/funcs/threeDModelAssetsDelete3DModelById.js";

// Use `LeonardoCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const leonardo = new LeonardoCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await threeDModelAssetsDelete3DModelById(leonardo, "<id>");

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
id string ✔️ "id" is required (enter it either in parameters or request body)
requestBody operations.Delete3DModelByIdRequestBody ➖ Query parameters can also be provided in the request body as a JSON object
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.Delete3DModelByIdResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

uploadModelAsset

This endpoint returns presigned details to upload a 3D model to S3

Example Usage

import { Leonardo } from "@leonardo-ai/sdk";

const leonardo = new Leonardo({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await leonardo.threeDModelAssets.uploadModelAsset();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
import { threeDModelAssetsUploadModelAsset } from "@leonardo-ai/sdk/funcs/threeDModelAssetsUploadModelAsset.js";

// Use `LeonardoCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const leonardo = new LeonardoCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await threeDModelAssetsUploadModelAsset(leonardo);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.UploadModelAssetRequestBody ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.UploadModelAssetResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*