Actions14
Run Full Pipeline Workflow
AI-generatedOverview
This node operation triggers a full pipeline workflow in the HumanFirst platform, waits for its completion, and then exports the resulting data. It is useful for automating the execution of data processing pipelines defined in HumanFirst playbooks and retrieving the processed output for further use or analysis. For example, a user can trigger a pipeline to process conversation data, wait for the pipeline to finish, and then download the results in JSON or CSV format.
Use Case Examples
- Trigger a pipeline to process conversation data and export the results as a JSON file.
- Run a pipeline workflow and retrieve the output as a CSV file for reporting or analysis.
Properties
| Name | Meaning |
|---|---|
| Namespace | The namespace in which the playbook and pipeline exist, used to scope the API request. |
| Playbook ID | The identifier of the playbook containing the pipeline to run. |
| Pipeline ID | The identifier of the pipeline to trigger and run. |
| Pipeline Step ID | Optional identifier of a specific pipeline step to filter the exported data. |
| Download Format | The format in which to download the exported data, either JSON or CSV. |
| Include Duplicates | Whether to include duplicate entries in the exported data, based on hash deduplication. |
| Order By | The ordering criteria for the exported data, such as creation date, auto, or random. |
| Order Direction | The direction of ordering, ascending (ASC) or descending (DSC). |
| Return Option Name or ID | Specifies whether to return the download URL or the list of texts from the exported data. |
Output
Binary
The node can output binary data representing the exported pipeline results as a file (JSON or CSV) when the return option is set to download URL.
JSON
exportId- Identifier of the export operation.pipelineId- Identifier of the pipeline that was run.download_url- URL to download the exported data file (if return option is download URL).triggerStatus- Status of the pipeline trigger after completion.texts- Array of text strings from the exported data (if return option is list of texts).
Dependencies
- HumanFirst API key credential
Troubleshooting
- If no triggerId is returned from the pipeline trigger request, the node throws an error indicating the trigger failed to start.
- If the pipeline trigger status is not completed successfully, the node throws an error with the status message.
- If the export URL path is missing in the export request response, the node throws an error indicating export failure.
- Timeouts may occur if the pipeline takes too long to complete; increasing the timeout or optimizing the pipeline may help.
Links
- HumanFirst API Documentation - Official API documentation for HumanFirst platform, useful for understanding pipeline triggering and data export endpoints.