Execute Task
AgentTools API
Execute Task
Create and start a scraping task from an AgentTools template.
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.
searchTemplates.
Required header
x-external-user-id is required for user-scoped execution.Row limit
targetMaxRows is optional and accepts values from 0 to 1000000.Request body fields
Request body fields
templateName is required.taskName is optional.parameters is optional, but must be a serialized JSON object when provided.targetMaxRows is optional.Status values
Status values
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.Important response fields
Important response fields
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.