Skip to main content
GET
/
api
/
agentTools
/
searchTasks
Search Tasks
curl --request GET \
  --url https://api.example.com/api/agentTools/searchTasks
import requests

url = "https://api.example.com/api/agentTools/searchTasks"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/agentTools/searchTasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/agentTools/searchTasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/agentTools/searchTasks"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/agentTools/searchTasks")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agentTools/searchTasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
The generated request and response examples are shown in the API panel. Use this page to understand the existing-task workflow.
Search existing Octoparse tasks before controlling or exporting them through AgentTools.
1

Find a task

Use keyword, status, or taskIds to locate existing tasks.
2

Read normalized status

Use taskStatusLabel for user-facing status and rawTaskStatusCode for lower-level diagnostics.
3

Continue the workflow

Use the returned taskId with startOrStopTask or exportData.
searchTasks -> startOrStopTask -> exportData

Required header

x-external-user-id is required for task search.

Status filters

Supported values are Running, Stopped, Completed, and Failed.
taskId identifies the task.taskName is the display name.taskDescription gives a short task summary when available.
page, size, total, and totalPages describe the result set.
Follow suggestedNextCall, workflow, and toolHint when deciding whether to call startOrStopTask or exportData.