Mix TypeScript SDK

Developer-friendly & type-safe TypeScript SDK for the Mix REST API - providing session management, messaging, and system operations.

Summary

Mix REST API: REST API for the Mix application - session management, messaging, and system operations

Table of Contents

• Mix TypeScript SDK
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Server-sent event streaming
  • File uploads
  • Retries
  • Error Handling
  • 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 mix-typescript-sdk

PNPM

pnpm add mix-typescript-sdk

Bun

bun add mix-typescript-sdk

Yarn

yarn add mix-typescript-sdk

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Mix } from "mix-typescript-sdk";

const mix = new Mix({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await mix.authentication.storeApiKey({
    apiKey: "<value>",
    provider: "openrouter",
  });

  console.log(result);
}

run();

Available Resources and Operations

Authentication

• storeApiKey - Store API key
• handleOAuthCallback - Handle OAuth callback
• startOAuthFlow - Start OAuth authentication
• getAuthStatus - Get authentication status
• validatePreferredProvider - Validate preferred provider
• deleteCredentials - Delete provider credentials
• getOAuthHealth - Get OAuth authentication health
• refreshOAuthTokens - Manually refresh OAuth tokens

Files

• list - List session files
• upload - Upload file to session
• delete - Delete session file
• get - Get session file

Health

• getOAuthHealth - Get OAuth authentication health

Internal

• refreshOAuthTokens - Manually refresh OAuth tokens

Messages

• getHistory - Get global message history
• cancelProcessing - Cancel agent processing
• getSession - List session messages
• send - Send a message to session (async)

Notifications

• respondToNotification - Respond to notification

Permissions

• deny - Deny permission
• grant - Grant permission

Sessions

• list - List all sessions
• create - Create a new session
• delete - Delete a session
• get - Get a specific session
• updateSessionCallbacks - Update session callbacks
• exportSession - Export session transcript
• rewindSession - Rewind a session

Streaming

• streamEvents - Server-Sent Events stream for real-time updates

System

• listCommands - List available commands
• getCommand - Get specific command
• listMcpServers - List MCP servers
• getSystemInfo - Get system information
• healthCheck - Health check

Tools

• listLLMTools - List LLM tools
• getToolCredentialsStatus - Get tool credentials status
• getToolsStatus - Get tools status

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.

• authenticationDeleteCredentials - Delete provider credentials
• authenticationGetAuthStatus - Get authentication status
• authenticationGetOAuthHealth - Get OAuth authentication health
• authenticationGetOAuthHealth - Get OAuth authentication health
• authenticationHandleOAuthCallback - Handle OAuth callback
• authenticationRefreshOAuthTokens - Manually refresh OAuth tokens
• authenticationRefreshOAuthTokens - Manually refresh OAuth tokens
• authenticationStartOAuthFlow - Start OAuth authentication
• authenticationStoreApiKey - Store API key
• authenticationValidatePreferredProvider - Validate preferred provider
• filesDelete - Delete session file
• filesGet - Get session file
• filesList - List session files
• filesUpload - Upload file to session
• messagesCancelProcessing - Cancel agent processing
• messagesGetHistory - Get global message history
• messagesGetSession - List session messages
• messagesSend - Send a message to session (async)
• notificationsRespondToNotification - Respond to notification
• permissionsDeny - Deny permission
• permissionsGrant - Grant permission
• sessionsCreate - Create a new session
• sessionsDelete - Delete a session
• sessionsExportSession - Export session transcript
• sessionsGet - Get a specific session
• sessionsList - List all sessions
• sessionsRewindSession - Rewind a session
• sessionsUpdateSessionCallbacks - Update session callbacks
• streamingStreamEvents - Server-Sent Events stream for real-time updates
• systemGetCommand - Get specific command
• systemGetSystemInfo - Get system information
• systemHealthCheck - Health check
• systemListCommands - List available commands
• systemListMcpServers - List MCP servers
• toolsGetToolCredentialsStatus - Get tool credentials status
• toolsGetToolsStatus - Get tools status
• toolsListLLMTools - List LLM tools

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as an async iterable that can be consumed using a for await...of loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

import { Mix } from "mix-typescript-sdk";

const mix = new Mix({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await mix.streaming.streamEvents({
    sessionId: "<id>",
  });

  for await (const event of result) {
    console.log(event);
  }
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Mix } from "mix-typescript-sdk";
import { openAsBlob } from "node:fs";

const mix = new Mix({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await mix.files.upload({
    id: "<id>",
    requestBody: {
      file: await openAsBlob("example.file"),
    },
  });

  console.log(result);
}

run();

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 { Mix } from "mix-typescript-sdk";

const mix = new Mix({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await mix.authentication.storeApiKey({
    apiKey: "<value>",
    provider: "openrouter",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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 { Mix } from "mix-typescript-sdk";

const mix = new Mix({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await mix.authentication.storeApiKey({
    apiKey: "<value>",
    provider: "openrouter",
  });

  console.log(result);
}

run();

Error Handling

MixError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Mix } from "mix-typescript-sdk";
import * as errors from "mix-typescript-sdk/models/errors";

const mix = new Mix({
  serverURL: "https://api.example.com",
});

async function run() {
  try {
    const result = await mix.authentication.storeApiKey({
      apiKey: "<value>",
      provider: "openrouter",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.MixError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.error); // models.RESTError
      }
    }
  }
}

run();

Error Classes

Primary errors:

• MixError: The base class for HTTP error responses.
  • ErrorResponse: *

Network errors:

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

Inherit from MixError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

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:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { Mix } from "mix-typescript-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "mix-typescript-sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 Mix({ httpClient: 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 { Mix } from "mix-typescript-sdk";

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

You can also enable a default debug logger by setting an environment variable MIX_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