sdk-javascript.mdx

title	JavaScript SDK
description	Learn how to use the Metorial JavaScript SDK for TypeScript and JavaScript applications

**What you'll learn:** - How to install the Metorial JavaScript SDK - How to use the SDK in the browser, Node.js, and Deno environments - How to make requests to the Metorial API using the SDK

Before you start:

• Create your API Keys

External resources:

• JavaScript SDK on GitHub

The Metorial JavaScript SDK provides a type-safe interface for interacting with the Metorial API. Use it to manage provider deployments, create sessions, handle OAuth flows, and integrate MCP tools into your applications.

The SDK works across all JavaScript environments including Node.js, browser applications, and Deno.

**Explore Node.js Examples:** Check out practical examples and sample code in the [metorial-node examples directory](https://github.com/metorial/metorial-node/tree/main/examples) on GitHub. Install the SDK using your preferred package manager:

<CodeGroup>
```bash npm
npm install metorial
```

```bash yarn
yarn add metorial
```
</CodeGroup>

To use the SDK, import the `Metorial` class and create an instance with your API key:

```javascript
import { Metorial } from 'metorial';

let metorial = new Metorial({
  apiKey: '$$SECRET_TOKEN$$'
});
```

You can now use the `metorial` instance to make requests to the Metorial API.

The SDK organizes API resources into logical namespaces. Each resource provides methods for common operations like `get()`, `list()`, `create()`, `update()`, and `delete()`.

```javascript
// List provider deployments
let deployments = await metorial.providerDeployments.list();

// Create a provider setup session (OAuth flow)
let setupSession = await metorial.providers.setupSessions.create({
  providerId: 'your-provider-id',
  providerAuthMethodId: 'oauth'
});
```

Each method returns a Promise that resolves with the response data. Use `async/await` or `.then()` to handle the results.

The SDK is written in TypeScript and includes type definitions for all API resources. You can use TypeScript to benefit from type checking and IntelliSense support:

```typescript
import { Metorial } from 'metorial';

let metorial = new Metorial({
  apiKey: '$$SECRET_TOKEN$$'
});

let deployment = await metorial.providerDeployments.get('pdp_Rm4Mnheq2bfEPhBhP7SY');

```