> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tybritelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# System

> Reference for the SystemService class in the TLDP SDK.

The `SystemService` class (accessed via `client.system`) exposes metadata about the API and a simple health check. Use these for connectivity tests, monitoring, and discovering what the API offers.

```typescript theme={null}
import { TLDP } from '@tybrite-labs/tldp-sdk';

const client = new TLDP({ apiKey: 'tybrite_sk_test_...' });
```

## getApiInfo

Returns basic information about the API — its name, the current version, and the catalogue of available endpoints. Handy for confirming which version you're integrating against.

```typescript theme={null}
const info = await client.system.getApiInfo({});

console.log(`${info.name} v${info.version}`);
console.log(info.endpoints); // catalogue of available endpoint groups
```

**Returns** the API name, version, and endpoint catalogue.

## getHealth

A lightweight health check. Use it for uptime monitors, readiness probes, or to confirm your network can reach the API before running a larger workflow.

```typescript theme={null}
const health = await client.system.getHealth({});

if (health.status === 'ok') {
  console.log('API is reachable and operational.');
}
```

**Returns** the health status (`status: 'ok'` when the API is operational).

> [!NOTE]
>
> These endpoints are intentionally minimal and low-cost — safe to poll from monitoring systems. They report API reachability, not the status of any individual shipment.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.