> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepshi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> The Deepshi API is an OpenAI-compatible gateway. Base URL: https://api.deepshi.ai/v1. API keys start with sk-bf- and go in the Authorization: Bearer header. Prefer the official OpenAI SDKs pointed at the Deepshi base URL. Model ids are clean with no provider prefix (e.g. deepshi-3.0, claude-opus-4.8, gpt-5.5). Chat and image requests are synchronous; video and music requests are asynchronous job APIs (create, then poll). Every synchronous response carries usage.cost.total_cost in USD. Do not reference the internal /api/* admin plane or virtual keys.

# Coding tools

> Use Deepshi models in AI coding assistants like Cursor and Cline.

Many AI coding tools let you bring your own OpenAI-compatible endpoint. Because the Deepshi API is OpenAI-compatible, you can route these tools through Deepshi by setting the base URL and your key.

## What you'll need

* The Deepshi base URL: `https://api.deepshi.ai/v1`
* Your Deepshi API key. See [Authentication](/get-started/authentication)
* A model id from the [catalog](/models/text-models)

## Cursor

In **Cursor → Settings → Models**:

1. Turn on **Override OpenAI Base URL** and set it to `https://api.deepshi.ai/v1` (Cursor appends `/chat/completions`).
2. Set the **OpenAI API Key** to your Deepshi key. The label says OpenAI, but the key is sent to the base URL you entered above.
3. Click **+ Add Model** and enter a Deepshi model id.

<Note>
  Cursor routes only its **chat panel** (Cmd/Ctrl+L) to a custom OpenAI base URL;
  the background coding agent keeps using Cursor's own backend. This behavior
  changes between versions, so check yours.
</Note>

## Other OpenAI-compatible tools

Most assistants and CLIs read the same two settings, often from environment variables:

```bash theme={null}
export OPENAI_BASE_URL="https://api.deepshi.ai/v1"
export OPENAI_API_KEY="YOUR_DEEPSHI_API_KEY"
```

Set those, choose a Deepshi model id, and the tool will route through Deepshi.
