TypeScript SDK

Install and start using the TypeScript SDK.

Intro

The Together APIs SDK provides access to the Together APIs REST APIs.

The Together REST API. See https://docs.together.ai for more details.

Installation

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

Terminal
npm install <path-to-sdk>

Quick Start

Create one client and reuse it. Configure its behaviour through ClientOptions.

TypeScript
import { ServerEnvironment, TogetherApIsClient } from "together-apis";

const client = new TogetherApIsClient({
  serverEnvironment: ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});

Nothing in ClientOptions is required — new TogetherApIsClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJS

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

TypeScript
import sdk = require("together-apis");

const client = new sdk.TogetherApIsClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});

On this page