AI Transport API reference

This reference covers every public API in the @ably/ai-transport package. The SDK is split into entry points, so you only import what you need.

Quick example

A client creates a transport for a conversation's channel, with a codec for its framework, and subscribes to its deliveries:

import * as Ably from 'ably';
import { createTransport } from '@ably/ai-transport';
import { openai } from '@ably/ai-transport/openai';

const ably = new Ably.Realtime({ authUrl: '/auth' });

const transport = createTransport({ client: ably, channelName: 'conversations:42', codec: openai });

transport.subscribe(({ event }) => {
  if (event !== undefined) render(event);
});

Entry points

Peer dependencies

ably is required. The rest are optional, and you only need the ones matching the entry points you import:

JavaScript

Transport

A transport publishes to and receives from one channel through one codec. The agent pipes the model's output to it, and the client sends its messages and subscribes to deliveries, with history replayed first when it asks.

OpenAI

AG-UI

Vercel

React

Errors