Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 5.02 KB

README.md

File metadata and controls

79 lines (53 loc) · 5.02 KB

User

(user)

Overview

Available Operations

getUserSelf

This endpoint will return your user information such as your user id, username, token renewal date and current amounts of the following: subscription tokens, gpt (prompt generation) tokens, and model training tokens

Example Usage

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

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

async function run() {
  const result = await leonardo.user.getUserSelf();

  // 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 { userGetUserSelf } from "@leonardo-ai/sdk/funcs/userGetUserSelf.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 userGetUserSelf(leonardo);

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
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.GetUserSelfResponse>

Errors

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