Skip to content

Input and Output

Learn how to configure Worker inputs and understand the output data structure.

Each Worker accepts input that tells it what to do. You can run a Worker from the CoreClaw Console UI and configure the input using the auto-generated form:

Input configuration UI

Configuring input via the UI is equivalent to passing input parameters as JSON. You can click Batch Edit to conveniently enter a large number of parameters at once.

When running a Worker via API, you pass the same input as a JSON object. For the example shown in the screenshot above, the corresponding JSON input would be:

[
{
"lang": "en-US",
"keyword": "711",
"max_results": 20,
"base_location": "New York",
"max_reviews_per_place": 5
}
]

As part of the input, you can also specify run options for your Worker, such as the script version, proxy node, timeout, and memory allocation.

Run Options

Worker output is structured data stored via push_data. The structure depends on the Worker’s purpose and is defined by the output_schema.json file.

In the Console you can export output data in eight formats:

FormatBest For
CSVSpreadsheets and data analysis
JSONDevelopers and API integration
JSONLLine-delimited, stream-friendly pipelines
XLSLegacy Excel workbooks
XLSXModern Excel workbooks
HTMLViewable in any browser
XMLLegacy and enterprise pipelines
RSSFeed readers and monitor-style integrations
  • Large datasets are paginated
  • Use API for streaming large results