Create tasks from templates

Use templates when the Octoparse catalog already contains a workflow for the website or data source you need.

Template commands require configured credentials in CLI v0.1.33 and later. Run octoparse auth login before searching or inspecting templates.

Search the template catalog

octoparse template search "Amazon" --page 1 --page-size 20
octoparse template search "Google Maps" --sort 1 --json

Template search uses the same catalog and default ranking as the Octoparse website.

Inspect a template

octoparse template view <templateId>
octoparse template version <templateId> --json

Use template view to review normalized parameters and generated creation examples before creating a task.

CLI commands and public JSON output use templateId. templateRegistrationId is an internal API field and should not be used in CLI integrations.

Create a template task

Pass simple values with repeated --param flags:

octoparse template-task create <templateId> \
  --name "My template task" \
  --param keyword=laptop \
  --param country=US \
  --json

For structured parameters, pass JSON directly or use a file:

octoparse template-task create <templateId> --params '{"keyword":"laptop"}' --json
octoparse template-task create <templateId> --params-file params.json --json

Preview the request without creating a remote task:

octoparse template-task create <templateId> --params-file params.json --dry-run --json

Update template parameters

octoparse template-task update <taskId> --params-file params.json --yes --json

Updating a template task changes remote state and requires --yes.

What’s next

Manage tasks

List, rename, move, copy, and validate the task you created.

Run locally

Run the template task with the embedded local engine.

OVERVIEW

GET STARTED

CREATE TASKS

TASKS AND RUNS

DATA

AUTOMATION

REFERENCE

Create tasks from templates

Search the template catalog

Inspect a template

Create a template task

Update template parameters

What’s next

Manage tasks

Run locally

​Search the template catalog

​Inspect a template

​Create a template task

​Update template parameters

​What’s next

Manage tasks

Run locally

Search the template catalog

Inspect a template

Create a template task

Update template parameters

What’s next