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

# Overview

> Overview — Kinetica TypeScript API

# Kinetica TypeScript API

The TypeScript API is published to npm as `@kinetica/gpudb-api`:

```
npm install @kinetica/gpudb-api
```

Type declarations for every request and response ship with the package and are picked up automatically; no separate `@types` package is needed.

```
import { GPUdb } from '@kinetica/gpudb-api';

const gpudb = new GPUdb('http://localhost:9191', {
    username: 'admin',
    password: 'password'
});

const response = await gpudb.show_system_properties({});
```

Each endpoint is available in two forms, both returning a `Promise` and both accepting an optional callback:

<ul>
  <li>positional parameters, e.g. `admin_add_host(host_address, options)`</li>
  <li>a single request object, e.g. `admin_add_host_request({ host_address, options })`</li>
</ul>

The request and response shapes are listed under **Request Types** and **Response Types**.The same package serves Node.js and browser applications; see the Node.js and JavaScript API references for the specifics of each. The source is on [GitHub](https://github.com/kineticadb/kinetica-api-typescript).


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