Connect your AI agent

Three ways to connect

• OAuth sign-in: you sign in to IPMusk in your browser and approve. No key to copy. Used by claude.ai, Claude Desktop and ChatGPT. Claude Code, Codex, Gemini CLI, Zed and Cursor can also sign in this way when you leave the key out.
• API key over MCP: a short config block that reads your key from IPMUSK_API_KEY. Best for coding tools (Claude Code, Codex, Cursor, Windsurf, Gemini CLI, VS Code, Cline, Zed) and agent SDKs (OpenAI Agents SDK, Vercel AI SDK, LangChain, MCP Python SDK).
• REST and OpenAPI: plain HTTPS calls with the same key. For any language or tool without MCP, and for Custom GPT Actions.

MCP server:   https://ipmusk.com/mcp
REST API:     https://ipmusk.com/api/v1
OpenAPI:      https://ipmusk.com/api/v1/openapi.json

Before you start

1. 1
   Create a key

   Sign in and go to Settings → API keys (/app/settings/api-keys). OAuth apps skip this step: you choose permissions on the IPMusk approval page instead.

2. 2
   Pick scopes

   For typical use pick read and connect. Add support to let the assistant open tickets. Add order only if it should create orders, which end in a payment link you pay yourself.

3. 3
   Keep the key out of chats

   Never paste a key into a chat message. Chats are stored and may be read by the model provider. Put the key in an environment variable named IPMUSK_API_KEY or in your client's config.

The full key is shown once. If you lose it, revoke it and create a new one.

Pick your client

Each guide is linked below.

• Chat apps: Claude (claude.ai and Claude Desktop) and ChatGPT.
• Coding tools: Claude Code, Codex, Cursor, Windsurf, Gemini CLI, VS Code, Cline and Zed.
• Agent SDKs: OpenAI Agents SDK, Vercel AI SDK, LangChain and the MCP Python SDK.
• Tools from Chinese vendors: see the next section.
• Anything else: the REST API guide, with curl, Python and Node.js examples.

Tools from Chinese vendors

The same three ways apply: coding tools and desktop clients take the MCP server with an API key, Dify can sign in with OAuth, and platforms without MCP import the OpenAPI schema or call the REST API.

• Coding tools: Qwen Code, iFlow CLI, Kimi Code, Trae, CodeBuddy, Tongyi Lingma and Baidu Comate.
• Chat clients: Cherry Studio and LobeHub.
• Agent platforms: Dify, Coze and Alibaba Cloud Model Studio.
• Model APIs without MCP: DeepSeek, Qwen, Kimi, GLM and MiniMax through their OpenAI-compatible chat APIs.

Not supported

Consumer chat apps such as Doubao (豆包), Yuanbao (元宝), the Kimi app and the DeepSeek app do not let users add MCP servers or plugins. Use one of the tools above, or the REST API.