API references
Access comprehensive API documentation for Genkit in your preferred programming language. These references provide detailed information about all available methods, classes, interfaces, and configuration options.
Go API reference
Section titled “Go API reference”Genkit Go is one module, github.com/firebase/genkit/go, split across the packages below. Godoc for each is on pkg.go.dev; the guide column is the narrative page that explains when to reach for it.
| Package | What’s in it | Guide |
|---|---|---|
genkit | Init, DefineFlow, DefineStreamingFlow, DefineTool, Generate, GenerateData, GenerateDataStream, Handler, HandlerFunc, and the genkit.With* options | Flows, Serve flows over HTTP |
ai | The generation types (Message, Part, ModelRequest, ModelResponse), tool and prompt types (ToolContext, Tool, Prompt), retrievers, embedders, and the ai.With* request options | Generating content, Tool calling |
core | Action context: ActionContext, WithActionContext, FromContext, ContextProvider, RequestData | Passing information through context |
core/status | Error classification: the status vocabulary, Errorf, PublicErrorf, Of, HTTPCode | Error types |
core/api | The Action, BidiAction, and Registry interfaces that transports and plugins are written against | Writing plugins |
ai/exp, genkit/exp, ai/exp/localstore | Preview: agents, sessions and snapshots, and the context.Context tool signature | Agents, API stability channels |
core/x/streaming | Preview: StreamManager and the in-memory implementation | Durable streaming |
plugins/... | Model, vector store, and observability providers, one subpackage each | Integrations |
Deprecations are marked in godoc, so check the symbol page before you adopt an option: ai.WithMiddleware, for example, is marked Deprecated: Use WithUse instead.
View Go API Reference
You can also read the same reference offline with go doc, which is often faster than the website:
go doc github.com/firebase/genkit/go/genkit Handlergo doc -all github.com/firebase/genkit/go/ai | lessCommunity and support
Section titled “Community and support”- GitHub Issues: Report bugs and request features in the Genkit repository
- Discord: Join community discussions on the Genkit Discord
- Stack Overflow: Ask questions using the
genkittag