Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 4.18 KB

README.md

File metadata and controls

47 lines (31 loc) · 4.18 KB
Raw

Heath

(ai.heath)

Available Operations

  • check - Health check endpoint, returns 200 OK if the service is operating correctly

check

Health check endpoint, returns 200 OK if the service is operating correctly

Example Usage

import { Kx } from "kx";

const kx = new Kx({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await kx.ai.heath.check();

  // 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<string>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /