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

# TypeScript SDK

> Install the TypeScript client, authenticate, and call the API.

The TypeScript client is `@parable-platform/web-api-sdk`. It covers every
endpoint in the [API Reference](/api-reference/overview).

<Info>
  Your Parable representative will confirm registry access if the package
  is not public yet.
</Info>

## Install

```bash theme={null}
npm install @parable-platform/web-api-sdk @parable-platform/web-api-types
```

## Import and authenticate

Create a client with your workspace API token. See
[Authentication](/getting-started/authentication) if you do not have one.

```typescript theme={null}
import { WebApiSDK } from "@parable-platform/web-api-sdk";

const token = process.env.PARABLE_API_TOKEN;
if (!token) {
  throw new Error("Set PARABLE_API_TOKEN");
}

const sdk = new WebApiSDK({
  baseUrl: "https://api.askparable.com",
  auth: { token },
});
```

The client sends `Authorization: Bearer ...` on every call.

## Read

Who you are, then the connectors configured in your workspace:

```typescript theme={null}
const me = await sdk.users.me();
console.log(me.name, me.email);

const connectors = await sdk.vendors.tenantConnectorInstances();
for (const connector of connectors) {
  console.log(connector.name, connector.connectionStatus);
}
```

## Update

Enable a tap. Replace the id with one from your workspace. List taps with
`sdk.tenantConnectorTaps.tenantConnectorTaps()`.

```typescript theme={null}
const tap = await sdk.tenantConnectorTaps.updateTenantConnectorTap(
  "018f2a3b-9c4d-7e5f-8a6b-1c2d3e4f5a6b",
  { enabled: true },
);

console.log(tap.id, tap.enabled);
```

Omitted fields are left unchanged. To disable the tap, pass
`{ enabled: false }`.

<Tip>
  This SDK maps directly to API names. Groups in the
  [API Reference](/api-reference/overview) are namespaces
  (`sdk.users`, `sdk.vendors`); operation names are methods
  (`me`, `tenantConnectorInstances`). If an endpoint is in that spec,
  it is on this client.
</Tip>