Plan batch
create_batch_planCreate a planned batch and its planned works in one call. This is the normal way to plan a batch once its scope is agreed. The batch name is 1 to 3 lowercase words joined by single hyphens, like dark-mode-toggle. The batch takes the next sequential number and queue position; works start planned in the order given, and the result carries each work's batch-scoped reference (like 4-1), ready for commit messages. create_work adds a Work to an existing Batch. When several workflow runs wait for a Batch, pass runId to plan it for that run. In a workflow run, this completes the planning step (and an open Evaluate-the-idea step), and edgeId can name the Batch stage route so no separate resume_workflow call is needed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Batch name: 1 to 3 lowercase words joined by single hyphens. | |
| runId | No | Workflow run this plan belongs to. | |
| works | Yes | Planned Works in order. | |
| edgeId | No | Id of the Workflow connection to take. | |
| metrics | No | Optional client measurements, stored on the workflow step this call completes. | |
| projectId | Yes | Id of the Project. | |
| requestId | No | Optional unique ID for this create. After a timeout, retry with the same requestId and arguments: the record already created is returned instead of a duplicate. |