Using ProxAI

Using ProxAI

This section is for running ProxAI as a local compatibility proxy. Start here if you are configuring providers, routing models, capturing one request, or debugging client-visible behavior.

1. 1Run locallyInstall or build ProxAI, generate the app directory, and point your client at the local proxy.
2. 2Configure providersKeep long-lived runtime behavior in config.toml.
3. 3Route intentionallyUse protocol-aware defaults and explicit routes only where needed.
4. 4Debug safelyUse compact logs and narrow capture phases without committing private artifacts.

Task docs first, reference second

Use these pages for workflows. Use Reference when you need exact fields, defaults, phase names, or behavior contracts.

Scope

ProxAI is	ProxAI is not
A local compatibility proxy for OpenAI-compatible and Anthropic-style traffic	A hosted multi-tenant AI gateway
An explicit protocol router with selected conversion pairs	A universal converter for every provider/protocol shape
A compact diagnostics tool for local Zed/proxy/provider problems	A prompt logging or analytics platform
A config.toml-centered local runtime	A provider management control plane

Pages

Quick StartRun ProxAI locally, find the app directory, edit config.toml, and connect a client.Install and UpgradeGet a binary, locate runtime files, upgrade safely, and roll back while preserving config.Client IntegrationBase URL, endpoints, local keys, model routing, error format, and streaming client behavior.Zed IntegrationPoint Zed at the local proxy, choose endpoints intentionally, and debug Responses/tool streaming safely.Provider SetupProvider names, protocols, base URLs, API keys, defaults, and explicit routes.Streaming and ToolsTerminal events, tool-call stalls, semantic timeouts, idle-read timeouts, and safe captures.Privacy and Local DataLocal artifacts, capture privacy, safe sharing, and what should never appear in logs.Known LimitationsIntentional non-goals, unsupported protocol pairs, lossy conversions, and local-data boundaries.Debugging WorkflowClassify failures, capture one phase, compare payloads, and sanitize evidence.RecipesTask paths for provider setup, model routing, safe captures, and streaming diagnosis.ConfigurationServer listeners, routing, providers, capture, logging, and error response behavior.Routing and ProvidersHow routes select providers and provider protocol controls outbound wire behavior.ObservabilityLogs, captures, request hints, and privacy boundaries for local debugging.TroubleshootingCommon symptoms, likely causes, and next checks across requests, providers, and streaming.