MetorialDocs

JavaScript SDK

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

Recommended reading

Before you start

External resources

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.

Info

Explore Node.js Examples: Check out practical examples and sample code in the metorial-node examples directory on GitHub.

Install the SDK

Install the SDK using your preferred package manager:

npm install metorial

Using the SDK

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

import { Metorial } from 'metorial';

let metorial = new Metorial({
  apiKey: 'metorial_sk_io2h4...'
});

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

Making requests

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

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

// Create a provider setup session (OAuth flow)
let setupSession = await metorial.providerDeployments.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.

Using TypeScript

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:

import { Metorial } from 'metorial';

let metorial = new Metorial({
  apiKey: 'metorial_sk_io2h4...'
});

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