LittleHorse API Reference
The LittleHorse Server exposes a GRPC API to its clients. For most general usage of LittleHorse, you will not need to read the raw protobuf schema. Common LittleHorse client actions fall into three general categories:
- Developing a Task Worker, which is handled by our Task Worker SDK's.
- Developing a WfSpec, which is handled by our
WfSpec
SDK's. - Running and interacting with
WfRun
's, which is documented in our "Using the API" docs.
However, the highly curious reader might want to see the actual GRPC and Protobuf specification. The docs on this page are autogenerated from our actual protobuf files.
The documentation of what the specific protobuf fields mean is potentially useful for advanced Jedi Master use-cases.
Happy Reading!
LittleHorse GRPC API
The LittleHorse GRPC API is the backbone of the clients that you get in all of our SDK's. Every LHConfig
object
gives you a GRPC stub to access the API. Most common operations are already documented with code examples in different
languages here, but we put this here for the true Jedi Masters.
RPC PutTaskDef
Request Type | Response Type | Description |
---|---|---|
PutTaskDefRequest | TaskDef | Creates a TaskDef. |
RPC GetTaskDef
Request Type | Response Type | Description |
---|---|---|
TaskDefId | TaskDef | Gets a TaskDef. |