1. Reference
  2. Python API reference

Import the supported user-facing surface from avalanche:

import avalanche as ava

​
Workflow authoring

APIPurpose
ava.sourceDeclare an ingest/create node
ava.stepDeclare a deterministic node
ava.transformAlias of ava.step
ava.destDeclare an explicit destination/final-action node
ava.workflowDeclare a runnable workflow DAG
ava.pipelineDeclare a pipeline
ava.inputSelect a runtime input field during graph construction
ava.Workflow, ava.PipelineConstructed workflow types

See Build a DAG.

​
Agent integration

APIPurpose
ava.AgentInjected callable agent type
ava.agent_step, ava.agent.stepDeclare an agent-backed workflow node
ava.Signature, ava.InputField, ava.OutputFieldDSPy-compatible typed model contract helpers
ava.agent.Skill, ava.agent.skillsPredictRLM skill surface
ava.agent.FilePredictRLM file type exposed by agent integration
ava.agent.capture_agent_evidenceCapture agent evidence events
ava.agent.AgentEvidenceEvent, AgentEvidenceListener, AgentEvidenceObserverEventAgent evidence event interfaces
ava.agent.AgentInvocationId, AgentTraceFinishedEvent, AgentTraceUnavailableEvent, ListenerErrorPolicyAgent evidence metadata and policies
ava.agent.AgentStepError, AgentStepExecutionErrorAgent-step error types

See Declare agent steps.

​
Runtime values and providers

APIPurpose
ava.BaseInput, ava.BaseContext, ava.RunContextTyped run input and context
ava.File, ava.WorkspacePortable file and directory values
ava.RunHandleAwaitable embedded-run lifecycle handle
ava.RerunPartial rerun descriptor
ava.Stream, ava.ModelStream, ava.consume_streamTable-backed runtime stream providers
ava.CursorManual table checkpoint provider
ava.LoggerInjected runtime logging provider
ava.ProgressStoreProgress tracking store

The avalanche.runtime namespace additionally exposes get_current_run_context, run_with_context, and LoggerInstance.

​
Executors and execution services

APIPurpose
ava.ExecutorExecutor protocol
ava.LocalExecutorLocal execution
ava.RayExecutorOptional Ray-backed execution
ava.get_default_executorResolve the configured default executor
ava.ExecutionServices, ava.ExecutionServicesSpecAdvanced executor-owned lifecycle provider and run specification
ava.ExecutionTaskSpec, ava.ExecutionServiceReceiptTask identity and terminal receipt types
ava.EXECUTION_SERVICES_V1Current execution-services protocol version

See Choose an executor and Integrate execution services.

​
Storage, tables, and lineage

APIPurpose
ava.Namespace, ava.NamespaceConfigBackend-neutral namespace contract and configuration
ava.Table, ava.TableGroup, ava.ScanResultBackend-neutral table interfaces and scan result
ava.AppendResultAppend result and typed conversion helpers
ava.SnapshotState, ava.SnapshotMetadataSnapshot metadata types
ava.JsonMark a model field for JSON storage

​
Iceberg and Lance

APIPurpose
ava.IcebergNamespace, ava.IcebergNs, ava.IcebergNsConfigIceberg namespace names and configuration
ava.IcebergTable, ava.IcebergTableGroup, ava.IcebergAppendScanIceberg tables and append scan provider
ava.LanceNamespace, ava.LanceNs, ava.LanceNamespaceConfig, ava.LanceNsConfigLance namespace names and configuration
ava.LanceTableLance-backed table

See schemas and tables and backend selection.

​
Other public types

APIPurpose
ava.WebhookWorkflow webhook declaration

Avalanche’s public surface is intentionally centered on the root package and ava.agent integration namespace. Operator, TUI, and browser implementation modules are documented as runtime behavior rather than supported application imports.