# ZRouter Agent Interface

ZRouter is a Super Intelligence Router: one OpenAI- and Anthropic-compatible endpoint that scores each AI request by difficulty and routes it to the right model and provider. This site is the machine-readable index of ZRouter's public product and API documentation.

## Discovery

- [/llms.txt](/llms.txt): LLM instructions
- [/llms-full.txt](/llms-full.txt): All docs in one file
- [/capabilities.json](/capabilities.json): Capabilities, endpoints, and limits
- [/openapi.json](/openapi.json): OpenAPI spec for account API keys
- [/mcp](/mcp): Account MCP server information
- [/mcp/tools.json](/mcp/tools.json): MCP tool catalog
- [/.well-known/mcp.json](/.well-known/mcp.json): MCP server card
- [/.well-known/api-catalog](/.well-known/api-catalog): API catalog (RFC 9727)

## Product surfaces

- Sending chat, Responses, Messages, embeddings, image, audio, and video requests through `https://zrouter.si/v1`
- Routing one virtual model name across providers by difficulty, schedule, cost, or failover
- Using the account's own provider keys (BYOK)
- Reading usage, request logs, and the prepaid credit ledger
- Managing API keys, virtual models, budgets, and rate limits through the account MCP server or `zctl`

New here? Start with the [quick start](/docs/quickstart.md).

**Access:** Model requests need an account API key and account management needs an MCP token or OAuth sign-in. A person creates the account, buys credit, and issues keys. This site grants no access to accounts or data.

## Documentation

- [Quick start](/docs/quickstart.md): Create an account, fund it, create an API key, and send a first request.
- [Authentication](/docs/authentication.md): Which credential to use for model requests, account management, and BYOK.
- [API reference](/docs/api.md): Endpoints available to account API keys, request formats, streaming, and unsupported features.
- [Errors and limits](/docs/errors.md): Status codes, what they mean, what an agent should do, and how credit reservations work.
- [Virtual models](/docs/virtual-models.md): One stable model name whose provider targets can change without code changes.
- [Super Intelligence Router](/docs/super-intelligence-routing.md): How ZRouter scores request difficulty and sends each request to a simple, standard, or complex tier.
- [Scheduled routing](/docs/scheduled-routing.md): Route a virtual model to different targets during peak and off-peak hours.
- [Bring your own keys (BYOK)](/docs/byok.md): Route requests through a provider key saved in the account so the provider bills it directly.
- [Credits and billing](/docs/credits.md): Prepaid USD credit, reservations, settlement, and the ledger.
- [Account MCP server](/docs/mcp.md): Manage a ZRouter account (usage, logs, routers, keys, budgets, limits) from an MCP client.
- [zctl CLI: Installation and Account Management](/docs/cli.md): Learn who should use zctl, when to use the CLI, how to install it, and how to manage ZRouter routers, API keys, credits, usage, and limits from a terminal.
- [Claude Code Setup: Connect to ZRouter](/docs/integrations/claude-code.md): Connect Claude Code to ZRouter with an account API key for text-file coding and client-executed tools, then pick models and check what billing covers.
- [Cline Setup: OpenAI Compatible Provider](/docs/integrations/cline.md): Configure Cline's OpenAI Compatible provider for ZRouter with your account API key, model ID, and supported text-tool workflows.
- [Codex Setup: Connect the CLI and IDE](/docs/integrations/codex.md): Configure the Codex CLI and IDE extension to use ZRouter as a custom Responses API provider, with your account key, a model choice, and the supported features.
- [Cursor Setup: Custom OpenAI Base URL](/docs/integrations/cursor.md): Point Cursor's custom OpenAI base URL at ZRouter, add your account key, choose models, and learn which Cursor features work through a custom endpoint.
- [LibreChat Setup: Custom ZRouter Endpoint](/docs/integrations/librechat.md): Add ZRouter to LibreChat as a custom endpoint, let each user supply their own account key, list models, and understand which LibreChat features are supported.
- [n8n Setup: Call ZRouter From Workflows](/docs/integrations/n8n.md): Call ZRouter from an n8n HTTP Request node: account authentication, an OpenAI-compatible request body, BYOK headers, and handling responses in your workflow.
- [OpenCode Setup: Custom OpenAI Provider](/docs/integrations/opencode.md): Define a custom OpenAI-compatible ZRouter provider in OpenCode: the base URL, your account API key, model names, and a quick check that requests go through.
- [Open WebUI Setup: Chat Through ZRouter](/docs/integrations/openwebui.md): Use ZRouter for text chat in Open WebUI: add a connection with a scoped account key, list your models, and keep usage and spending under your account limits.
- [Python, Node.js and HTTP: OpenAI SDK Setup](/docs/integrations/sdks.md): Use ZRouter from the OpenAI Python and Node.js SDKs, curl, and streaming clients: set the base URL and account key, pick a model, and send BYOK requests.
- [Connection checks & troubleshooting](/docs/integrations/troubleshooting.md): Fix common ZRouter connection problems: the gateway URL, API keys, model names, credit, BYOK, streaming, and coding agent compatibility errors, step by step.