API Reference#

Public Interfaces

Flowkit exposes the following core packages:

  • pkg/function — function registry and execution logic

  • pkg/external_function_system/grpcserver — GRPC server lifecycle and handlers

  • proto/ — GRPC service definitions and contracts

RegisterFunction API
func RegisterFunction(name string, fn *Function) error

Used to attach a Go function to the Flowkit runtime registry.

Function Signature
type Function struct {
  Name        string
  Description string
  Run         func(context.Context, *Request) (*Response, error)
  Stream      bool
  RunStream   func(context.Context, *Request, ServerStream) error
}

All functions must implement the Run handler. If Stream is true, then RunStream should also be defined.

Note

This page is a placeholder for future auto-generated API documentation.