Skip to main content
Use the Octoparse OpenAPI to manage tasks, run cloud extractions, and retrieve scraped data programmatically.

​
AgentTools API

AgentTools API is a template-driven, AI-agent workflow layer on top of the legacy low-level Task, Cloud Extraction, and Data APIs. Use it when an agent or automation needs to discover a suitable scraping template, start a run, follow server-provided next-step guidance, and retrieve export metadata without wiring together every low-level endpoint directly. New scraping flow:
Existing task flow:
New to AgentTools? Read the end-to-end workflow tutorial to learn how to search templates, start a task, and export results. AgentTools responses keep business fields inside data. Use requestId only for troubleshooting, and follow retryGuidance, suggestedNextCall, workflow, and toolHint instead of hard-coding polling intervals.
AgentTools API uses x-api-key authentication. Some endpoints also require x-external-user-id; see each endpoint reference for exact headers.

​
Before you start

To use the Octoparse OpenAPI, you need a Standard, Professional, or Enterprise account with at least one working task. Sign up here if you don’t have one yet. Current API version: v1.0

​
Base URL

All requests must be URL-encoded against the base URL:
Placeholders are shown as {xxxx} and need to be replaced with real values. For example, the request URL for Search Task is:
If your task group ID is abc, the URL becomes https://openapi.octoparse.com/task/search?taskGroupId=abc.

​
Rate limits

Octoparse limits API usage to 20 requests per second. If you receive a 429 status code, slow your request rate. A successful response returns HTTP 200. For other status codes, see the References section in each endpoint.

​
Permissions

Make sure your account has permission to use each service. If not, upgrade your account.

​
Troubleshooting

Every response includes a requestId. If a request fails, share the requestId with the Octoparse support team to help diagnose the issue.