Workflows API

// List all workflows with aggregated counts
const response: Response = await fetch("http://localhost:3000/api/workflows");
const workflows: Workflow[] = await response.json();

workflows.forEach((wf) => {
const def: { pattern: string } = JSON.parse(wf.definition);
console.log(`${wf.name} [${wf.status}] — ${def.pattern}, ${wf.taskCount} tasks, ${wf.outputDocCount} docs`);
});

// Create a parallel workflow — pricing and features run concurrently,
// synthesis waits for both to finish
const response: Response = await fetch("http://localhost:3000/api/workflows", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
  name: "Competitive Analysis",
  projectId: "proj-8f3a-4b2c",
  definition: {
    pattern: "parallel",
    steps: [
      { id: "pricing", name: "Pricing Research", prompt: "Analyze competitor pricing models" },
      { id: "features", name: "Feature Comparison", prompt: "Compare feature sets across top 5 competitors" },
      { id: "synthesis", name: "Synthesis", prompt: "Combine pricing and feature analysis into a final report", dependsOn: ["pricing", "features"] },
    ],
  },
}),
});
const workflow: Workflow = await response.json();

console.log(workflow.id);     // "wf-4a7c-e2d1"
console.log(workflow.status); // "draft"

// Rename a draft workflow before execution
await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1", {
method: "PATCH",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Competitive Analysis v2" }),
});

// Delete a workflow — must not be in active state
const res: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1", { method: "DELETE" });

if (res.status === 409) {
console.log("Pause the workflow first before deleting");
}

// Start the workflow — returns immediately while steps run in background
const res: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/execute", {
method: "POST",
});

if (res.status === 202) {
const { workflowId }: { workflowId: string } = await res.json();
console.log("Workflow started — poll /status to track progress");
} else if (res.status === 409) {
console.log("Workflow is already running");
}

// Poll workflow status to display step-by-step progress
const response: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/status");
const status: WorkflowStatus = await response.json();

console.log(`Workflow: ${status.status}, Run #${status.runNumber}`);

// Display per-step progress
for (const step of status.steps) {
const duration: string = step.completedAt && step.startedAt
  ? ((new Date(step.completedAt).getTime() - new Date(step.startedAt).getTime()) / 1000).toFixed(1) + "s"
  : "—";
console.log(`  ${step.stepId}: ${step.status} (${duration})`);
}

// List workflow documents to see inputs and outputs
const response: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/documents");
const docs: { bindingId: string; documentId: string; stepId?: string }[] = await response.json();

// Separate workflow-wide vs step-scoped documents
const globalDocs = docs.filter((d) => !d.stepId);
const scoped = docs.filter((d) => d.stepId);
console.log(`${globalDocs.length} global, ${scoped.length} step-scoped documents`);

// Attach documents scoped to the research step only
const response: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/documents", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
  documentIds: ["doc-competitor-data-q4", "doc-pricing-spreadsheet"],
  stepId: "research",
}),
});
const { attached }: { attached: number } = await response.json();

console.log(`Attached ${attached} documents to research step`);

// Remove a specific document binding
await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/documents", {
method: "DELETE",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ documentIds: ["doc-competitor-data-q4"] }),
});

// Retry a failed step — the workflow engine picks up from here
const res: Response = await fetch("http://localhost:3000/api/workflows/wf-4a7c-e2d1/steps/research/retry", {
method: "POST",
});

if (res.status === 202) {
console.log("Retry started — downstream steps will re-execute when this completes");
}

// Create and execute in one call — no need for a separate execute request
const response: Response = await fetch("http://localhost:3000/api/workflows/from-assist", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
  name: "Quick Analysis",
  definition: {
    pattern: "sequence",
    steps: [
      { id: "analyze", name: "Analyze", prompt: "Analyze the Q4 revenue dataset and produce a summary" },
    ],
  },
  executeImmediately: true,
}),
});
const { workflow, taskIds, status }: { workflow: Workflow; taskIds: string[]; status: string } = await response.json();

console.log(`Workflow ${workflow.id}: ${status}`); // "started"
console.log(`Task IDs: ${taskIds.join(", ")}`);