Connect an agent

VSCode + Cline

Cline is an AI coding agent extension for VS Code. Point its API provider to Yomi API to read and modify code in your editor using models such as claude-sonnet-5.

Prerequisites

VS Code: Installed and working.
API key: Create a key in the console's API Keys page, copy it and store it safely. It is visible only at creation.

Install the Cline extension

Open the VS Code Extensions Marketplace.
Search for Cline and click Install.
After installation, open the Cline panel from the sidebar. At first launch, select "Bring my own API key".

Cline first-launch options — On first opening Cline, choose "Bring my own API key" to use your own provider and key.

Configure Yomi API

Cline settings entry — The gear icon in the upper-right corner of the Cline panel opens Settings (highlighted in red).

Open Cline Settings.
API Provider: Select "OpenAI Compatible".
Base URL: Enter https://api.yomiapi.com/v1.
API Key: Enter YOUR_API_KEY.
Model ID: Enter claude-sonnet-5 (recommended for coding), or gpt-5.6-sol.
Save the settings.

API Provider must be "OpenAI Compatible", rather than the official OpenAI option, which will not send requests to the Yomi API address.

Start and verify

Enter a small task in the Cline panel, such as asking it to explain selected code. A normal response confirms successful setup.
Sign in to the console and check "Usage" in the User Center. The corresponding record confirms that the request went through Yomi API.

Common questions

What should I enter for Model ID?

Enter a model ID from the platform catalog (such as claude-sonnet-5, gpt-5.6-sol, deepseek-v4-pro), not a display name. See Models (the Model Catalog) in the console for available IDs.

What if the context limit is exceeded?

If the task's code or conversation is too long, change Model ID to kimi-k3 (1M context), or start a new session to reduce accumulated context.