Stop Workspace task group
stop_workspace_task_groupStop every worker in a Plori task group: running runs are cancelled, unstarted workers never start, and saved files, revisions, and agents remain.
Instructions
Stop every worker of a task group: workers that have not started never start, and running worker runs are cancelled. Their copies, saved revisions and agents are kept. Plori does not submit a stopped worker's files; submit_workspace_changeset can still submit a worker whose files are saved. The group starts no new workers afterwards. To stop one running worker only, use cancel_run with its run_id and workspace_id. Returns the group state (stopping until every run has ended, then stopped) and the runs whose cancellation was requested.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | Yes | The Workspace UUID. | |
| task_group_id | Yes | The task group to stop (task_group_id of a worker). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runs | Yes | The group's runs whose cancellation this call requested. | |
| state | Yes | stopping until every worker run of the group has ended, then stopped. A stopped group starts no new workers. | |
| task_group_id | Yes | The task group UUID. |