跳转至

apogee-ai-workflow

Long-running, durable agent workflows with HIL pause/resume.

This page is being expanded

The tables below are generated from the package source, so they are accurate. Narrative guides and worked examples are being written module by module.

Public API

Everything below is exported from the package root, so from apogee_ai_workflow import X works for each name.

Layer Symbols
Application · DTOs CancelRunDTO, GateDecisionDTO, ResumeRunDTO, StartRunDTO
Application · Use cases ApproveGateUseCase, CancelRunUseCase, GetRunUseCase, ListGatesUseCase, ListRunsUseCase, RegisterWorkflowUseCase, RejectGateUseCase, ResumeRunUseCase, StartRunUseCase
Domain Checkpoint, CompensationFailed, EngineConfig, EngineUnavailable, GateDecision, GateNotFound, GateRejected, HumanGate, RetryPolicy, RunContext, RunStatus, SagaCompensation, Step, StepHandler, StepIO, StepRun, StepStatus, Workflow, WorkflowAlreadyRegistered, WorkflowDefinition, WorkflowRun
Domain · Enums RetryPolicyKind, StepKind
Domain · Exceptions RunNotFoundException, StepFailedException, WorkflowError, WorkflowNotFoundException
Domain · Protocols (ports) ICheckpointer, IHumanGateGateway, IRunRepository, ISagaCompensator, IWorkflowEngine, IWorkflowRepository
Infrastructure DBOSAdapter, DefaultSagaCompensator, InMemoryCheckpointer, InMemoryHumanGateGateway, InMemoryRunRepository, InMemoryWorkflowRepository, JsonCheckpointer, JsonHumanGateGateway, JsonRunRepository, NativeWorkflowEngine, RestateAdapter, SqlCheckpointer, TemporalAdapter, WorkflowEngineRegistry

Install

Bash
pip install apogee-ai-workflow

The base install has no required third-party dependency. Each extra unlocks one adapter.

Extra Pulls in
sql sqlalchemy>=2.0, asyncpg>=0.29, aiosqlite>=0.20
redis redis>=5.0
temporal temporalio>=1.7
restate restate-sdk>=0.5
dbos dbos>=0.20
all sqlalchemy>=2.0, asyncpg>=0.29, aiosqlite>=0.20, redis>=5.0, temporalio>=1.7, restate-sdk>=0.5, dbos>=0.20

CLI

Installed as a console script, and registered as an apogee plugin so the same subcommands work under the global binary.

Bash
apogee-workflow --help