speakeasy-admin

Developer-friendly & type-safe Typescript SDK specifically catered to leverage speakeasy-admin API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Speakeasy API: The Speakeasy Admin API to manage internal operations on Organizations, Users, Workspaces, and Billing.

Table of Contents

• speakeasy-admin
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add speakeasy-admin

PNPM

pnpm add speakeasy-admin

Bun

bun add speakeasy-admin

Yarn

yarn add speakeasy-admin zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "SpeakeasyAdmin": {
      "command": "npx",
      "args": [
        "-y", "--package", "speakeasy-admin",
        "--",
        "mcp", "start",
        "--scope", "read"
      ],
      "env": {
        "SPEAKEASY_API_KEY": "<YOUR_SPEAKEASY_SELF_WORKSPACE_API_KEY>"
      }
    }
  }
}

Go to Cursor Settings > Features > MCP Servers > Add new MCP server and use the following settings:

• Name: SpeakeasyAdmin
• Type: command
• Command:

npx -y --package speakeasy-admin -- mcp start --api-key ... 

For a full list of server arguments, run:

npx -y --package speakeasy-admin -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({});

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ------ | ------- | -------------------- | | apiKey | apiKey | API key | SPEAKEASY_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({});

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

admin

• searchOrganizations - Paginated search through speakeasy organizations.
• getOrganization - Get a particular organization by ID or slug. Organization slugs are present in speakeasy URLs (https://app.speakeasy.com/org/speakeasy-self/admin-sdk). Slugs are always in snakecase and often match the organization name converted to snake case.
• getOrganizationWorkspaces - Get all workspaces for a particular organization by ID
• getOrganizationBillingLimits - Get billing limits for a particular organization by ID.
• getOrganizationUsage - Returns a billing usage summary by SDK language for a particular organization ID.
• getAddOns - Returns a paginated list of all active billing add ons across all organizations.
• getOrganizationAddOns - Get add ons for a particular organization by ID.
• searchUsers - Paginated search through speakeasy users.
• getUserWorkspaces - Returns all workspaces for a particular user by user ID.
• getUser - Get a particular user by ID or email.
• getWorkspaces - Returns a paginated list of all Speakeasy workspaces.
• getWorkspaceUsers - Returns all users for a particular workspace by workspace ID.
• getWorkspace - Get a particular workspace by ID or org and workspace slug. Both slugs are present in speakeasy URLs (https://app.speakeasy.com/org/speakeasy-self/admin-sdk). Slugs are always in snake case and often match the name of the entity converted to snake case.
• searchEvents - Returns a list of CLI event results that match the search criteria.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• adminGetAddOns - Returns a paginated list of all active billing add ons across all organizations.
• adminGetOrganization - Get a particular organization by ID or slug. Organization slugs are present in speakeasy URLs (https://app.speakeasy.com/org/speakeasy-self/admin-sdk). Slugs are always in snakecase and often match the organization name converted to snake case.
• adminGetOrganizationAddOns - Get add ons for a particular organization by ID.
• adminGetOrganizationBillingLimits - Get billing limits for a particular organization by ID.
• adminGetOrganizationUsage - Returns a billing usage summary by SDK language for a particular organization ID.
• adminGetOrganizationWorkspaces - Get all workspaces for a particular organization by ID
• adminGetUser - Get a particular user by ID or email.
• adminGetUserWorkspaces - Returns all workspaces for a particular user by user ID.
• adminGetWorkspace - Get a particular workspace by ID or org and workspace slug. Both slugs are present in speakeasy URLs (https://app.speakeasy.com/org/speakeasy-self/admin-sdk). Slugs are always in snake case and often match the name of the entity converted to snake case.
• adminGetWorkspaces - Returns a paginated list of all Speakeasy workspaces.
• adminGetWorkspaceUsers - Returns all users for a particular workspace by workspace ID.
• adminSearchEvents - Returns a list of CLI event results that match the search criteria.
• adminSearchOrganizations - Paginated search through speakeasy organizations.
• adminSearchUsers - Paginated search through speakeasy users.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({});

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the searchOrganizations method may throw the following errors:

| Error Type | Status Code | Content Type | | --------------- | ----------- | ---------------- | | errors.ErrorT | 4XX | application/json | | errors.APIError | 5XX | */* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.

import { SpeakeasyAdmin } from "speakeasy-admin";
import { ErrorT, SDKValidationError } from "speakeasy-admin/models/errors";

const speakeasyAdmin = new SpeakeasyAdmin({
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  let result;
  try {
    result = await speakeasyAdmin.admin.searchOrganizations({});

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ErrorT): {
        // Handle err.data$: ErrorTData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

| Name | Server | Description | | ------ | ----------------------------------- | ----------- | | prod | https://api.prod.speakeasyapi.dev | |

Example

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  server: "prod",
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({});

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { SpeakeasyAdmin } from "speakeasy-admin";

const speakeasyAdmin = new SpeakeasyAdmin({
  serverURL: "https://api.prod.speakeasyapi.dev",
  apiKey: process.env["SPEAKEASY_API_KEY"] ?? "",
});

async function run() {
  const result = await speakeasyAdmin.admin.searchOrganizations({});

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { SpeakeasyAdmin } from "speakeasy-admin";
import { HTTPClient } from "speakeasy-admin/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new SpeakeasyAdmin({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { SpeakeasyAdmin } from "speakeasy-admin";

const sdk = new SpeakeasyAdmin({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable SPEAKEASY_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy