HealthResource: Check Figranium Server Status

check

check(options?: RequestOptions): Promise<HealthStatus>

Performs a GET /api/health request and returns the server’s health status. This is the fastest way to verify connectivity and SDK configuration.

Returns

HealthStatus extends UnknownRecord for forward compatibility, so newer servers can add fields without breaking existing consumers. Common fields include:

status: a human-readable status string such as "ok"
version: the running Figranium server version

Example: verify connectivity

const status = await figranium.health.check();
console.log(status.status);   // "ok"
console.log(status.version);  // "0.14.4"

Example: browser usage

Because check() requires no authentication, you can call it from a browser before the user has signed in or provided an API key:

const figranium = new Figranium({ baseUrl: "https://figranium.example" });
const status = await figranium.health.check();

Example: handle transport failures

Wrap check() in a try/catch to detect network or DNS issues. Transport failures surface as FigraniumError with code: "NETWORK_ERROR":

import { FigraniumError } from "@figranium/sdk";

try {
  const status = await figranium.health.check();
  console.log("Server is up:", status.status);
} catch (error) {
  if (error instanceof FigraniumError && error.code === "NETWORK_ERROR") {
    console.error("Cannot reach the Figranium server. Check the baseUrl and network.");
  }
  throw error;
}

The check() method accepts the standard RequestOptions object as its final argument, so you can pass a custom signal, timeoutMs, or extra headers when needed.

Intro

Installation

Basics

Features

Agent Logic

API

JavaScript SDK

Integrations

Ops

Changelog

HealthResource: Check Figranium Server Status

Client setup

Methods

Returns

Example: verify connectivity

Example: browser usage

Example: handle transport failures

​Client setup

​Methods

​Returns

​Example: verify connectivity

​Example: browser usage

​Example: handle transport failures

Client setup

Methods

Returns

Example: verify connectivity

Example: browser usage

Example: handle transport failures