Skip to content

Chat

(llm.chat)

Overview

Available Operations

createChatCompletionStream

Streaming chat completion endpoint designed for use with the generated TypeScript/JavaScript SDK from the OpenAPI specification. This endpoint uses ORPC's native streaming via async generators and returns Server-Sent Events (SSE) formatted as structured JSON chunks. Unlike the OpenAI client endpoint, this provides better type safety and integration with the generated SDK. Use this endpoint when working with the auto-generated API client for type-safe streaming responses. The endpoint supports response caching, request resumption via x-last-chunk-index header, and automatic usage tracking.

Example Usage

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

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

async function run() {
  const result = await sdk.llm.chat.createChatCompletionStream({
    model: "ATS",
    messages: [
      {
        role: "assistant",
        content: [],
      },
    ],
  });

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

run();

Standalone function

The standalone function version of this method:

typescript
import { SDKCore } from "@meetkai/mka1/core.js";
import { llmChatCreateChatCompletionStream } from "@meetkai/mka1/funcs/llmChatCreateChatCompletionStream.js";

// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await llmChatCreateChatCompletionStream(sdk, {
    model: "ATS",
    messages: [
      {
        role: "assistant",
        content: [],
      },
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    for await (const event of result) {
    console.log(event);
  }
  } else {
    console.log("llmChatCreateChatCompletionStream failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

tsx
import {
  // Mutation hook for triggering the API call.
  useLlmChatCreateChatCompletionStreamMutation
} from "@meetkai/mka1/react-query/llmChatCreateChatCompletionStream.js";

Parameters

ParameterTypeRequiredDescription
requestoperations.CreateChatCompletionStreamRequestBody✔️The request object to use for the request.
optionsRequestOptionsUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigEnables retrying HTTP requests under certain failure conditions.

Response

Promise<EventStream<operations.CreateChatCompletionStreamResponseBody>>

Errors

Error TypeStatus CodeContent Type
errors.APIError4XX, 5XX*/*