# Zrelay documentation

## Get started

- [Introduction](https://zrelay.net/docs/md/index.md): One gateway. Your models. Your stack.
- [Quickstart](https://zrelay.net/docs/md/quickstart.md): From your account to your first API response.
- [Models](https://zrelay.net/docs/md/models.md): Choose the model, endpoint and pool together.

## Capabilities

- [Streaming](https://zrelay.net/docs/md/capabilities/streaming.md): Receive output incrementally with server-sent events.
- [Thinking](https://zrelay.net/docs/md/capabilities/thinking.md): Reasoning controls depend on the model and route.
- [Tool calling](https://zrelay.net/docs/md/capabilities/tool-calling.md): Let a model propose actions that your application controls.
- [Images](https://zrelay.net/docs/md/capabilities/images.md): Generate images on an enabled image route.
- [Spending controls](https://zrelay.net/docs/md/capabilities/spending-controls.md): Control account spend and individual keys.

## Workflows

- [Security review](https://zrelay.net/docs/md/security-review.md): A practical workflow for reviewing code you are authorized to assess.

## Agents

- [Agent compatibility](https://zrelay.net/docs/md/agents.md): Use your preferred agent with the right API format.
- [Quick setup](https://zrelay.net/docs/md/agents/quick-setup.md): The connection settings most agents need.
- [Coding agents](https://zrelay.net/docs/md/agents/coding-agents.md): Setup guides and compatibility checks for coding tools.
- [Codex](https://zrelay.net/docs/md/agents/coding-agents/codex.md): Set up Codex for Zrelay with client-specific configuration and an AI setup prompt.
- [OpenCode](https://zrelay.net/docs/md/agents/coding-agents/opencode.md): Set up OpenCode for Zrelay with client-specific configuration and an AI setup prompt.
- [fx](https://zrelay.net/docs/md/agents/coding-agents/fx.md): Set up fx for Zrelay with client-specific configuration and an AI setup prompt.
- [Crush](https://zrelay.net/docs/md/agents/coding-agents/crush.md): Set up Crush for Zrelay with client-specific configuration and an AI setup prompt.
- [Continue](https://zrelay.net/docs/md/agents/coding-agents/continue.md): Set up Continue for Zrelay with client-specific configuration and an AI setup prompt.
- [aider](https://zrelay.net/docs/md/agents/coding-agents/aider.md): Set up aider for Zrelay with client-specific configuration and an AI setup prompt.
- [Qwen Code](https://zrelay.net/docs/md/agents/coding-agents/qwen-code.md): Set up Qwen Code for Zrelay with client-specific configuration and an AI setup prompt.
- [Claude Code](https://zrelay.net/docs/md/agents/coding-agents/claude-code.md): Set up Claude Code for Zrelay with client-specific configuration and an AI setup prompt.
- [Cursor](https://zrelay.net/docs/md/agents/coding-agents/cursor.md): Set up Cursor for Zrelay with client-specific configuration and an AI setup prompt.
- [Claude Desktop](https://zrelay.net/docs/md/agents/coding-agents/claude-desktop.md): Set up Claude Desktop for Zrelay with client-specific configuration and an AI setup prompt.
- [VS Code](https://zrelay.net/docs/md/agents/coding-agents/vscode.md): Set up VS Code for Zrelay with client-specific configuration and an AI setup prompt.
- [Antigravity CLI (Gemini)](https://zrelay.net/docs/md/agents/coding-agents/antigravity.md): Set up Antigravity CLI (Gemini) for Zrelay with client-specific configuration and an AI setup prompt.
- [ZCode](https://zrelay.net/docs/md/agents/coding-agents/zcode.md): Set up ZCode for Zrelay with client-specific configuration and an AI setup prompt.
- [Grok Build](https://zrelay.net/docs/md/agents/coding-agents/grok-build.md): Set up Grok Build for Zrelay with client-specific configuration and an AI setup prompt.
- [Cline](https://zrelay.net/docs/md/agents/coding-agents/cline.md): Set up Cline for Zrelay with client-specific configuration and an AI setup prompt.
- [Build an agent](https://zrelay.net/docs/md/agents/build.md): Build a small, bounded agent loop.
- [Add Zrelay to a project](https://zrelay.net/docs/md/agents/setup-prompt.md): Give your coding assistant the connection contract.
- [Docs for agents](https://zrelay.net/docs/md/agents/docs-for-agents.md): A compact integration contract for AI assistants configuring Zrelay.

## Integrations

- [SDKs and frameworks](https://zrelay.net/docs/md/integrations/sdks.md): Use native formats through a custom base URL.
- [OpenAI SDKs](https://zrelay.net/docs/md/integrations/sdks/openai.md): Set up OpenAI SDKs for Zrelay with client-specific configuration and an AI setup prompt.
- [Vercel AI SDK](https://zrelay.net/docs/md/integrations/sdks/vercel-ai-sdk.md): Set up Vercel AI SDK for Zrelay with client-specific configuration and an AI setup prompt.
- [LangChain](https://zrelay.net/docs/md/integrations/sdks/langchain.md): Set up LangChain for Zrelay with client-specific configuration and an AI setup prompt.

## API reference

- [Authentication](https://zrelay.net/docs/md/api/authentication.md): Your key, standard headers.
- [Chat completions](https://zrelay.net/docs/md/api/chat-completions.md): POST /v1/chat/completions
- [Responses (preview)](https://zrelay.net/docs/md/api/responses.md): POST /v1/responses
- [List models](https://zrelay.net/docs/md/api/models.md): Discover models and verify route availability.
- [Credits](https://zrelay.net/docs/md/api/credits.md): Prepaid USD balance, usage and request history.
- [Errors](https://zrelay.net/docs/md/api/errors.md): Understand failures and decide when to retry.
- [Limits](https://zrelay.net/docs/md/api/limits.md): Account, model and application limits.
- [Compatibility](https://zrelay.net/docs/md/api/compatibility.md): Native request formats, one API host.