Use an API key to authenticate requests to the Octoparse API, MCP skills, or automation platforms such as Make and n8n. An API key is a unique credential used to authenticate your requests.
⚠️ Important Note
Treat your API key like a password. Store it securely and do not share it publicly.
What is an API Key
An API key is an authentication token that tells the system a request is being made by you or on behalf of your account.
When you send requests to Octoparse through the API or MCP-related integrations, the system uses the API key to verify your identity. These API calls typically consume credits from your account balance, so it is a good idea to check your available credits before you begin.
How to Create an API Key
Step 1: Open the API Keys page
Navigate to Account and security > API Keys and sign in to your Octoparse account.
Step 2: Click the create button
Click Create API Key or + New API Key.
Step 3: Generate your key
Copy the generated API key and store it in a safe place.
Note: The full API key will only be shown once, so be sure to save it immediately.
Step 4. Manage API Keys
Click Disable to temporarily deactivate an API key.
Click Delete to permanently remove an API key. This action cannot be undone.
What Can You Use an API Key For
After creating an API key, you can use it in several common scenarios:
You can authenticate requests to the Octoparse API for programmatic access to your account and workflows.
You can also use it with MCP skills, where authentication is required to connect external tools or AI workflows to Octoparse capabilities.
In addition, automation platforms such as Make and n8n can use your API key to connect with Octoparse and build automated flows.
Recommended Best Practices
To use API keys safely and efficiently, follow these recommendations:
Use separate API keys for different projects or environments whenever possible. This makes management easier and reduces risk.
Keep production and testing environments separate. Do not reuse the same key across every use case.
Document where each key is being used internally so your team can manage renewals, troubleshooting, and rotation more effectively.
Review unused keys regularly and remove any that are no longer needed.
Troubleshooting
If you are unable to create or use an API key, check the following:
Make sure you are signed in to the correct Octoparse account.
Confirm that you are on the API Keys page under Account and security.
Check whether your account has the necessary balance or credits if your workflow depends on API consumption.
Ensure the key is copied correctly and has not been truncated or modified.
If the issue persists, refer to the official documentation or contact support.