Methods Reference
The Stepflow Protocol defines methods and notifications for communication between the runtime and component servers. This reference provides a complete overview of all available methods organized by category.
Method Categories
The protocol methods are organized into four main categories:
- Initialization - Protocol connection and capability negotiation
- Components - Component discovery, introspection, and execution
- Blob Storage - Content-addressable data storage and retrieval
- Flows - Workflow expression evaluation and context access
Complete Method Reference
| Method | Direction | Type | Description |
|---|---|---|---|
| Initialization | |||
initialize | Runtime → Component | Request | Negotiate protocol version and establish capabilities |
initialized | Runtime → Component | Notification | Confirm initialization is complete |
| Components | |||
components/list | Runtime → Component | Request | Discover all available components |
components/info | Runtime → Component | Request | Get detailed component information and schema |
components/execute | Runtime → Component | Request | Execute a component with input data |
| Blob Storage | |||
blobs/put | Component → Runtime | Request | Store JSON data and receive content-addressable ID |
blobs/get | Component → Runtime | Request | Retrieve data by blob ID |
| Flows | |||
flows/evaluate | Component → Runtime | Request | Evaluate workflow expressions in runtime context |