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

# Node.js SDK

> Official TypeScript/JavaScript SDK for Arb Platform API

## Installation

Install the Arb SDK using npm or your preferred package manager:

<CodeGroup>
  ```bash npm theme={null}
  npm install @arb-inc/node
  ```

  ```bash yarn theme={null}
  yarn add @arb-inc/node
  ```

  ```bash pnpm theme={null}
  pnpm add @arb-inc/node
  ```
</CodeGroup>

## Quick Start

Set up your API key as an environment variable:

```bash theme={null}
export ARB_INC_API_KEY="your_api_key_here"
```

Create a file called `example.js` and add this code:

```javascript theme={null}
import ArbInc from '@arb-inc/node';

const client = new ArbInc({
  apiKey: process.env['ARB_INC_API_KEY'], // This is the default and can be omitted
});

const _case = await client.cases.create({ 
  primaryUserID: 'c17c3433-81b3-4096-90e0-9fbb32c06204' 
});

console.log(_case.caseID);
```

Execute the code with `node example.js`. You should see the case ID output.

## TypeScript Support

The SDK includes full TypeScript definitions for all request params and response fields:

```typescript theme={null}
import ArbInc from '@arb-inc/node';

const params: ArbInc.CaseCreateParams = { 
  primaryUserID: 'c17c3433-81b3-4096-90e0-9fbb32c06204' 
};
const _case: ArbInc.CaseCreateResponse = await client.cases.create(params);
```

<Card title="Learn more on GitHub" icon="github" href="https://github.com/arb-inc/arb-node">
  Discover more SDK capabilities, configuration options, and complete API documentation on the library's GitHub README.
</Card>

<Card title="View on npm" icon="npm" href="https://www.npmjs.com/package/@arb-inc/node">
  See package details, version history, and installation statistics.
</Card>

## Requirements

* Node.js 20 LTS or later
* TypeScript >= 4.9 (for TypeScript users)

## Support

For SDK issues or questions:

* [Open an issue on GitHub](https://github.com/arb-inc/arb-node/issues)
* Email support at [support@arb.inc](mailto:support@arb.inc)