Skip to main content
POST
Start Or Stop Task
The request body, generated cURL example, and response schema are shown in the API panel.
Start or stop an existing Octoparse task through AgentTools.
1

Locate the task

Use searchTasks when the task ID is not already known.
2

Request an action

Send action as start or stop.
3

Continue with export

Use exportData when response guidance indicates data may be available.

Request body

taskId and action are required.

Actions

Allowed action values are start and stop.
start_requested and stop_requested mean the request was accepted.already_running and already_stopped mean no state change was needed.start_rejected, stop_rejected, and invalid require client-side handling or user review.
Follow retryGuidance, suggestedNextCall, workflow, and toolHint instead of hard-coding polling intervals.