MKA1 TypeScript SDK

Appearance

MKA1 TypeScript SDK ​

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



Summary ​

MKA1 API: The MKA1 API is a RESTful API that provides access to the MKA1 platform. Learn how to get started with the API and the TypeScript SDK here.

Table of Contents ​

SDK Installation ​

TIP

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

NPM ​

bash
npm add git+https://github.com/MeetKai/mk1-sdks.git?subdir=typescript
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM ​

bash
pnpm add https://github.com/MeetKai/mk1-sdks#path:typescript
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun ​

bash
bun add https://github.com/MeetKai/mk1-sdks
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn ​

bash
yarn add https://github.com/MeetKai/mk1-sdks
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

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 from npm.

Claude installation steps

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

json
{
  "mcpServers": {
    "SDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@meetkai/mka1",
        "--",
        "mcp", "start",
        "--bearer-auth", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

json
{
  "mcpServers": {
    "SDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@meetkai/mka1",
        "--",
        "mcp", "start",
        "--bearer-auth", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

bash
curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

json
{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

sh
npx -y --package @meetkai/mka1 -- mcp start --help

Requirements ​

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage ​

Example ​

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  });
}

run();

Authentication ​

Per-Client Security Schemes ​

This SDK supports the following security scheme globally:

NameTypeScheme
bearerAuthhttpHTTP Bearer

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

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  });
}

run();

Per-Operation Security Schemes ​

Some operations in this SDK require the security scheme to be specified at the request level. For example:

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK();

async function run() {
  const result = await sdk.agents.listAgents({
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  }, {});

  console.log(result);
}

run();

Available Resources and Operations ​

Available methods

AgentRuns ​

Agents ​

Auth.ApiKey ​

Guardrails ​

Llm.Batches ​

Llm.Chat ​

  • createChat - [Deprecated] Chat completions for OpenAI SDK/client usage ⚠️ Deprecated
  • stream - [Deprecated] Streaming chat completions for generated SDK usage ⚠️ Deprecated

Llm.Classify ​

  • classify - Classify text into predefined categories

Llm.Conversations ​

Llm.Embeddings ​

Llm.Extract ​

Llm.Feedback ​

Llm.Files ​

Llm.Images ​

  • create - Generate images from text descriptions

Llm.Models ​

Llm.Prompts ​

Llm.Responses ​

  • create - Create an agent-powered response with tool support
  • list - List all responses with pagination
  • get - Retrieve response by ID with status and results
  • update - Update a response
  • delete - Permanently delete a response and its data
  • cancel - Cancel an in-progress background response
  • listInputItems - List paginated input items for a response
  • compact - Compact a conversation

Llm.Skills ​

Llm.Speech ​

Llm.Usage ​

Llm.VectorStores ​

Permissions.Llm ​

  • grant - Grant permission to a user or make public
  • revoke - Revoke permission from a user or remove public access
  • check - Check user permission

Sandbox ​

Schema5Other ​

Search.Graphrag ​

Search.Tables ​

Search.TextStore ​

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.

Available standalone functions

React hooks with TanStack Query ​

React hooks built on TanStack Query are included in this SDK. These hooks and the utility functions provided alongside them can be used to build rich applications that pull data from the API using one of the most popular asynchronous state management library.

To learn about this feature and how to get started, check REACT_QUERY.md.

WARNING

This feature is currently in preview and is subject to breaking changes within the current major version of the SDK as we gather user feedback on it.

Available React hooks

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.

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.responses.create({
    model: "meetkai:functionary-urdu-mini-pak",
    input: "What is the capital of France?",
  });

  console.log(result);
}

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.
typescript
import { SDK } from "@meetkai/mka1";
import { openAsBlob } from "node:fs";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.files.upload({
    file: await openAsBlob("example.file"),
    purpose: "assistants",
  });

  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:

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });
}

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:

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  });
}

run();

Error Handling ​

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

PropertyTypeDescription
error.messagestringError message
error.statusCodenumberHTTP response status code eg 404
error.headersHeadersHTTP response headers
error.bodystringHTTP body. Can be empty string if no body is returned.
error.rawResponseResponseRaw HTTP response
error.data$Optional. Some errors may contain structured data. See Error Classes.

Example ​

typescript
import { SDK } from "@meetkai/mka1";
import * as errors from "@meetkai/mka1/models/errors";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  try {
    const result = await sdk.llm.files.content({
      fileId: "file-abc123",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SDKError) {
      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.GetFileContentResponseBody) {
        console.log(error.data$.error); // errors.GetFileContentLlmFilesResponse400Error
      }
    }
  }
}

run();

Error Classes ​

Primary error:

  • SDKError: The base class for HTTP error responses.
Less common errors (20)

Network errors:

Inherit from SDKError:

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

Server Selection ​

Select Server by Index ​

You can override the default server globally by passing a server index to the serverIdx: number 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 indexes associated with the available servers:

#ServerDescription
0https://apigw.mka1.comMKA1 API Gateway
1/Relative server URL (configurable via SDK constructor)

Example ​

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  serverIdx: 0,
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  });
}

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:

typescript
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  serverURL: "https://apigw.mka1.com",
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  await sdk.permissions.llm.grant({
    resourceType: "completion",
    resourceId: "my-completion-123",
    userId: "user-abc456",
    role: "writer",
  });
}

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:

  • 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
typescript
import { SDK } from "@meetkai/mka1";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@meetkai/mka1/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 SDK({ 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.

typescript
import { SDK } from "@meetkai/mka1";

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

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.

Copyright © 2024-present MeetKai