Choose an import path

The package root is the curated, provider-neutral API. Import concrete providers, framework bindings, extensions, and low-level infrastructure through subpaths so application dependencies remain explicit.

Stable root

Prefer createApiClient and CapabilityClient for application integrations. Use @cavi-ai/api-client for the universal runtime and gateway contracts, provider registries and factories, capability guards, shared errors, graceful degradation, route contracts, and team-manifest types.

import {
  createApiClient,
  createRuntimeClient,
  createRuntimeProviderRegistry,
  runtimeSupports,
  type RuntimeClient,
} from "@cavi-ai/api-client";

Core subpaths

For direct HTTP integration, see response ownership, cancellation, and typed errors.

Provider subpaths

Broad provider entries remain available for compatibility. Prefer narrow entries when an application needs only one provider surface.

Extensions, frameworks, and testing

package.json is the authoritative list of published entry points. The generated type reference lists the symbols available from the locked stable documentation artifact, including the OpenCode provider subpath.

Transport boundaries

The universal transport entry exports createHttpTransport, createJsonRpcTransport, createSseTransport, and createWebSocketTransport. The Node-only entry exports createStdioTransport and createUnixSocketTransport without pulling Node built-ins into browser-facing entry points.

Transport reconnects are bounded and never replay pending writes. These factories are infrastructure, not a provider adapter, and do not imply that a provider implements a corresponding capability.