Skip to main content
Local discovery of the complete workflow graph.

Workflow Objects

Read-only graph snapshot loaded with the project. Discovery is local. Refresh the project to load a new graph snapshot.

id

Workflow identifier.

stages

Every stage, including Start, routers and all terminal outcomes.

pathways

All connections, in the order returned by the backend.

get_task

Fetch one current or historical task, subject to backend read permissions.

release_tasks

Release manual tasks’ current assignments atomically without moving them. Requires project management access. Tasks may span stages in this project; already-unassigned tasks succeed. Empty batches raise ValueError; the backend enforces batch limits. Unavailable tasks raise StaleTaskError. Leaves snapshots unchanged; sent requests are not automatically retried.

get_stage

Find a stage by exact name or ID. Arguments:
  • name - Exact name. Duplicate names require ID lookup.
  • id - Unique stage identifier, as a UUID or string.
  • type_ - Expected stage class, also used for return-type narrowing.
Raises:
  • ValueError - Selectors are missing, conflicting, ambiguous, malformed or unmatched.
  • TypeError - The matching stage is not of the requested type.