Getting startedGuide reviewed 2026-09-13

Choose your integration

Find the setup guide for your editor, agent, or application on macOS, Linux, and Windows.

Follow updates
On this page

Choose the tool you use, then follow its installation, configuration, and verification steps. New to the API? Start with Quickstart.

Editors and agents #

IntegrationmacOSLinuxWindowsStart here
CursorDesktopDesktopDesktopChat setup and limitations
Cline and ContinueVS Code extensionVS Code extensionVS Code extensionExtension setup
Roo Code — legacyDiscontinuedDiscontinuedDiscontinuedStatus and migration
VS Code built-in ChatDesktopDesktopDesktopCustom Endpoint
Codex VS Code extensionVS Code extensionVS Code extensionNative or WSLExtension setup
ZedDesktopDesktopDesktopCustom provider
Claude CodeTerminalTerminalPowerShell or WSLClaude Code
Codex CLITerminalTerminalPowerShell or WSLCodex CLI
OpenCodeTerminalTerminalPowerShell or WSLOpenCode
OpenClawTerminal / GatewayTerminal / GatewayNative or WSLOpenClaw
AiderTerminalTerminalPowerShell or WSLAider
OpenHandsDocker / CLIDocker / CLIWSL2 + DockerOpenHands

These are setup paths, not a certification of every OS version, client release, or model. Use each vendor's current supported OS/runtime and a model with the capabilities your tool requires. Cursor custom models are subject to Cursor's own support and account restrictions.

Application libraries #

Python, JavaScript, and TypeScript examples can run on macOS, Linux, and Windows:

Prepare the environment and runtime, then run the complete example in the matching guide.

Pick the right URL #

ClientSettingValue
OpenAI SDKs, OpenCode, Aider, Zed, Cline, ContinueBase URLhttps://api.routerplex.com/v1
Claude Code and Anthropic SDKsBase URLhttps://api.routerplex.com
CodexBase URL + wire APIhttps://api.routerplex.com/v1 + responses
VS Code Custom EndpointModel endpointhttps://api.routerplex.com/v1/chat/completions

Use exact model IDs from the catalog. Only tools such as Aider and OpenHands add an openai/ prefix; OpenCode and OpenClaw use their configured routerplex/ provider prefix.

Check a connection #

  1. Send the short test from your guide.
  2. Confirm it returned a reply.
  3. Find the request under your dedicated key in Usage.
  4. For coding agents, also try a small disposable-file task to check tools and permissions.

If the connection fails, see environment setup and Errors. If an editor rejects a custom model, try the Quickstart with the same key to isolate the problem.

Choose your integration — Docs