Inkeep Chat API TS SDK

SDK Installation

NPM

npm add @inkeep/ai-api

Yarn

yarn add @inkeep/ai-api

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";

const inkeepAI = new InkeepAI({
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await inkeepAI.chatSession.create({
        integrationId: "<value>",
        chatSession: {
            messages: [
                {
                    content: "<value>",
                },
            ],
            tags: ["<value>"],
        },
        chatMode: ChatModeOptions.Auto,
    });

    if (res.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of res.chatResultStream) {
        // Handle the event
    }
}

run();

Available Resources and Operations

chatSession

create - Create Chat Session
continue - Continue Chat Session

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 { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";

const inkeepAI = new InkeepAI({
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await inkeepAI.chatSession.create({
        integrationId: "<value>",
        chatSession: {
            messages: [
                {
                    content: "<value>",
                },
            ],
            tags: ["<value>"],
        },
        chatMode: ChatModeOptions.Auto,
    });

    if (res.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of res.chatResultStream) {
        // Handle the event
    }
}

run();

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4xx-5xx	/

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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";
import * as errors from "@inkeep/ai-api/models/errors";

const inkeepAI = new InkeepAI({
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    let result;
    try {
        result = await inkeepAI.chatSession.create({
            integrationId: "<value>",
            chatSession: {
                messages: [
                    {
                        content: "<value>",
                    },
                ],
                tags: ["<value>"],
            },
            chatMode: ChatModeOptions.Auto,
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.HTTPValidationError: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    if (res.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of res.chatResultStream) {
        // Handle the event
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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:

#	Server	Variables
0	`https://api.inkeep.com`	None

import { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";

const inkeepAI = new InkeepAI({
    serverIdx: 0,
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await inkeepAI.chatSession.create({
        integrationId: "<value>",
        chatSession: {
            messages: [
                {
                    content: "<value>",
                },
            ],
            tags: ["<value>"],
        },
        chatMode: ChatModeOptions.Auto,
    });

    if (result.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of result.chatResultStream) {
        // Handle the event
    }
}

run();

Override Server URL Per-Client

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

import { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";

const inkeepAI = new InkeepAI({
    serverURL: "https://api.inkeep.com",
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await inkeepAI.chatSession.create({
        integrationId: "<value>",
        chatSession: {
            messages: [
                {
                    content: "<value>",
                },
            ],
            tags: ["<value>"],
        },
        chatMode: ChatModeOptions.Auto,
    });

    if (result.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of result.chatResultStream) {
        // Handle the event
    }
}

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 { InkeepAI } from "@inkeep/ai-api";
import { HTTPClient } from "@inkeep/ai-api/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 InkeepAI({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`apiKey`	http	HTTP Bearer

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

import { InkeepAI } from "@inkeep/ai-api";
import { ChatModeOptions } from "@inkeep/ai-api/models/components";

const inkeepAI = new InkeepAI({
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await inkeepAI.chatSession.create({
        integrationId: "<value>",
        chatSession: {
            messages: [
                {
                    content: "<value>",
                },
            ],
            tags: ["<value>"],
        },
        chatMode: ChatModeOptions.Auto,
    });

    if (result.chatResultStream == null) {
        throw new Error("failed to create stream: received null value");
    }

    for await (const event of result.chatResultStream) {
        // Handle the event
    }
}

run();

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

inkeep/ai-api-ts