› cavi-ai/
GitHub ↗

API client overview

@cavi-ai/api-client is a provider-agnostic TypeScript client for AI agent runtimes. One RuntimeClient contract covers Claude (including Managed Agents), Codex, Gemini, Hermes, OpenClaw, and related gateway surfaces — HTTP, WebSocket RPC, SSE, and optional React bindings.

This documentation set is the immutable product docs for a published package version. Upstream runtimes remain the protocol owners; this client mirrors and verifies compatible behavior.

This client mirrors and verifies upstream-compatible behavior. Upstream runtimes remain the canonical protocol owners.

Start here

  1. Installation — install the package and pick a provider entry.
  2. Quickstart — first startRun / gateway call.
  3. Runtime client — the universal contract.
  4. Operations — OpenAPI-style operation reference.
  5. Postman — prove gateway surfaces against a live host.

How this docs set is published

  • Docs site (cavi-ai.xyz): ingests the GitHub release asset

cavi-api-client-docs-vX.Y.Z.tar.gz (canonical).

  • npm package: may include the same docs/api-client/vX.Y.Z tree for offline

reading; it is not the site ingest authority.

See the consumer contract in docs/api-client/CONSUMER.md for validation rules.