Connect Coze to IPMusk

Who this is for

People who build bots and workflows on Coze (扣子) from ByteDance, on coze.cn or coze.com.

This guide covers plugins built from the REST API. MCP support in Coze is not covered here.

What you need

• An IPMusk account with a verified email address.
• An IPMusk API key with read and connect. Add support or order only if the bot should open tickets or create orders.
• This client takes the key itself rather than reading the IPMUSK_API_KEY environment variable the other guides use. Keep the original in a password manager.
• IPMusk applies the same source-country rules to the API and MCP as to the website, so connect from a region where ipmusk.com is available.

Set it up

• Everyone who uses the bot acts with your key. Keep the bot private, or give it a key with only the scopes you are happy to share.
• Field names differ between coze.cn and coze.com and change over time. If a step does not match, check Coze's current documentation.

1. 1
   Create a plugin

   In Coze, open Plugins and choose Create plugin. Pick the option to create it from an existing service, or to import OpenAPI.

2. 2
   Import the schema

   Paste the OpenAPI URL below, or download the file from it and upload that.

3. 3
   Add your key

   Choose the token or Bearer authorization option. Send it in the header named Authorization with the value Bearer followed by a space and your key.

4. 4
   Test and publish

   Test one tool, such as me_get, then publish the plugin.

5. 5
   Use it

   Add the plugin to a bot or a workflow.

https://ipmusk.com/api/v1/openapi.json

Check it works

Test the me_get tool in the plugin editor. It should return your email address.

Then ask the bot: Which IPMusk account am I connected as?

Try these prompts

• How much residential traffic do I have left on IPMusk?
• Give me a rotating residential proxy URL for Germany.
• List my Static ISP proxies and when they expire.

If it fails

• Import from URL fails: download the schema and upload the file instead. If Coze rejects the schema itself, check which OpenAPI versions its current documentation accepts.
• Every tool returns 401: the value must be Bearer, a space and the key, sent in the Authorization header.
• 403 forbidden on one tool: the key lacks that tool's scope, or your email is not verified. Create a new key with the scope and update the plugin.
• 429 rate_limited: too many calls in one minute (read 60, connect 20, support 30, order 10). Wait a minute and try again.
• 403 capability_unavailable: the customer API is switched off on this deployment. Contact support.

Remove access

• Revoke the key in Settings → API keys (/app/settings/api-keys). It stops working at once.
• Then remove the plugin from your bots and workflows, and delete it in Coze.