Connect external tools to the OpenDesign Cloud API

Manage your OpenDesign API keys on the web and use plan-supported models in an external agent. The OpenDesign desktop app is not required. One-click setup imports the connection through CC Switch on your computer.

Choose the connection you need

To bring a provider key into OpenDesign, follow BYOK setup. This guide covers the other direction: using the OpenDesign Cloud model API from an external tool such as Claude Code or Codex.

Before you start

OpenDesign Cloud API is available with Go, Plus, Pro, and Max plans. Free is not supported. Your account’s Model list determines which text models you can use; models shown in screenshots are examples, not entitlements for every plan.

Supported agents are Claude Code, Codex, Grok Build, OpenCode, OpenClaw, and Hermes Agent. Install your chosen agent first. If CC Switch is already installed, you can skip its installation step.

Open API keys on the web

Sign in to OpenDesign account management on the web and choose API keys in the sidebar. Select One-click agent setup at the upper right. You can start without an existing key.

The complete API keys page: One-click agent setup is at the upper right; Connection setup contains API formats and their base URLs.

For manual setup, open Connection setup, select the API format required by your tool—Chat Completions, Responses, or Messages—and copy its API base URL. Keep the endpoint and protocol matched. The steps below show one-click import.

Step 1: Install and open CC Switch

In One-click agent setup, select Download for Mac or Download for Windows.
Install and open CC Switch. Skip this step if it is already installed.

Step 2: Choose an agent and model

Select your target agent. Claude Code is selected by default.
Choose a text model from the Model list for your plan. If no model is available, choose another agent or check your plan; copying a model name from a screenshot does not grant access.

The setup dialog: choose the target agent, then a model available to your account.

Step 3: Import and restart

Select Import into CC Switch. This creates a new key named for the agent and system, such as Claude Code · Mac, and opens CC Switch.
Allow Open CC Switch in the browser prompt. Review the API Endpoint, key, and model in CC Switch, then select Import.
Return to the web page and select Done, or Set up another agent for another connection.
Restart the target agent. For Claude Code, exit the current session and run claude in a new terminal.

The CC Switch confirmation window: check the endpoint and model before importing. The key in this screenshot is masked.

Each one-click setup creates a new key; it cannot reuse an existing one. Existing keys are unaffected. Your previous agent configuration remains available in CC Switch.

Verify the active connection

Send a short message in the restarted agent and confirm that it replies.
In Claude Code, run /status and compare the model with your selection. Use the equivalent status view in other agents.
On the web API keys page, check whether the new key’s Last used time updates.

If the old model is still active, close the old session and restart the agent. If the browser did not open CC Switch, check its confirmation prompt near the address bar, open CC Switch, and select Open again. Later model changes can be made in CC Switch without repeating setup.

Switch back or revoke access

In CC Switch, find the agent’s previous configuration and enable it to switch back. Removing a CC Switch configuration does not disable the API key. Revoke the key on the web API keys page when you want it to stop working.

Check the account page for your current plan and model availability. See the one-click agent setup tutorial for the full recording and screenshots, or Subscriptions and billing for account setup.

Do API calls share app credits?

Yes. Regular API calls share plan allowances and usage windows with the app. Creating another key or switching agents does not reset them. Promotional credits may have separate API eligibility terms. See credits and usage.

Open the Cloud console to manage keys and usage. Tools such as Zcode that accept a custom model endpoint and key can be configured for the matching API protocol. This does not mean OpenDesign can launch that tool as a built-in local agent.

Requests with images exceed the size limit

Current support guidance specifies a 50 MiB API request-body limit. It applies to the entire body, not to each image; image encoding also increases its size. Reduce the number or dimensions of images and retry a small request. If it still fails, provide the response status, request time and model to support without exposing your key.