stable documentation / v0.11.0
One typed client. Every agent runtime.
A provider-neutral TypeScript client for compatible HTTP, WebSocket, and SSE runtime surfaces. The package follows upstream protocols; runtime owners remain canonical.
Quickstart
Install the stable package and run a complete Codex request.
02Core concepts
Understand runtime clients, providers, transports, and capabilities.
03Verified contracts
Trace declarations, fixtures, and conformance evidence.
04API reference
Search every stable export and declaration signature.
compile-checked example
Start with the runtime you already use.
Provider-specific adapters implement the shared runtime contract without claiming ownership of the upstream protocol.
import { CodexApiClient } from
"@cavi-ai/api-client/providers/codex/runtime";
const client = new CodexApiClient({
apiKey: process.env.OPENAI_API_KEY,
defaultModel: "gpt-5",
});
const run = await client.startRun({
input: "Explain capability checks.",
});