Skip to main content
POST
Execute Task
The request body, generated cURL example, and response schema are shown in the API panel. Use this page for execution rules that are easy to miss.
Create and start a scraping task from a template returned by searchTemplates.
1

Choose a template

Pass templateName from searchTemplates.
2

Serialize parameters

Send parameters as a JSON object serialized as a string.
3

Follow server guidance

Use retryGuidance, suggestedNextCall, workflow, and toolHint instead of fixed polling intervals.

Required header

x-external-user-id is required for user-scoped execution.

Row limit

targetMaxRows is optional and accepts values from 0 to 1000000.
Source-backed fields must use option keys. MultiInput and multiselect-like fields must use arrays, even for one item.
templateName is required.taskName is optional.parameters is optional, but must be a serialized JSON object when provided.targetMaxRows is optional.
accepted: the task was accepted for execution.ready: data may be ready to export.awaiting_source_selection: a source-backed field needs a valid option key.invalid, start_failed, and failed: check recoverySuggestion, blockingIssues, missingParamNames, and invalidSourceSelections.
taskId identifies the task to export or inspect.lotNo identifies the batch or run. Pass it to exportData when returned.recoverySuggestion, blockingIssues, missingParamNames, and invalidSourceSelections help the client repair invalid calls.