Skip to main content

Endpoint

Description

Pauses a running task at the next workflow checkpoint. The current activity (LLM call, tool, etc.) is allowed to finish, and then the workflow blocks until it is resumed or cancelled. Use this when you want to temporarily stop long‑running research or supervisor workflows without losing progress.

Authentication

Required: Yes Include API key in header:

Request

Headers

Path Parameters

Body Parameters

Request Body Example

Response

202 Accepted

404 Not Found

409 Failed Precondition

Cannot pause task in invalid state:

401 / 403

or

Notes

  • Pause takes effect at well‑defined checkpoints (e.g., pre_execution, pre_completion); it does not interrupt in‑flight activities.
  • While paused, SSE streams will emit workflow.pausing and workflow.paused events with a checkpoint field.
  • Ownership and tenancy are enforced: users can only pause their own tasks.