Skip to main content
This guide explains how to create, list, inspect, update, and delete tasks in a way that supports long-lived workflows: scheduled monitors, repeated exports, and evolving definitions as sites or APIs change. The examples emphasize classic tasks (URLs + objective + schema); modular and multi-step shapes use the same endpoints with different bodies—see Action types overview.

Task lifecycle at a glance

Core task fields

For modular single-action tasks, bodies also include fields such as action_type, input_source, limits, and payload as required by your template. For multi-step tasks, an execution_plan carries steps instead of combining with all of the top-level fields above—validation rules are documented on POST /api/v1/tasks in the API Reference.

Create a task

Use:
Example request:

List and inspect tasks

Use:
Typical list query options:

Update a task

Use:
Update tasks when you need to change:
  • The target URLs
  • The objective
  • The output schema
  • The execution mode
  • The schedule
  • Template-related configuration

Delete a task

Use:
Deletion affects the task definition itself. Historical executions remain a separate concern from the task object.

Task design guidance

Common mistakes

Next steps