Examples
Examples are grouped by what they prove and by whether they need real provider credentials. Start with no-key examples for deterministic protocol, runtime, and generated-package behavior. Use provider-api examples when you want the live provider request path.
Provider API examples
AxGenOpenAIExample.java
AxGen OpenAI API run
Commandnpm run example -- java AxGenOpenAIExample.java
EnvOPENAI_API_KEY, OPENAI_APIKEY
AgentOpenAIExample.java
AxAgent OpenAI API run
Commandnpm run example -- java AgentOpenAIExample.java
EnvOPENAI_API_KEY, OPENAI_APIKEY
FlowOpenAIExample.java
AxFlow OpenAI API run
Commandnpm run example -- java FlowOpenAIExample.java
EnvOPENAI_API_KEY, OPENAI_APIKEY
LLM, media, and realtime examples
ProviderMappingNoKeyExample.java
OpenAI-compatible mapping smoke
Commandnpm run example -- java ProviderMappingNoKeyExample.java
Env
None
ProviderStreamNoKeyExample.java
OpenAI-compatible streaming smoke
Commandnpm run example -- java ProviderStreamNoKeyExample.java
Env
None
AudioResponsesMappingExample.java
OpenAI Responses audio mapping
Commandnpm run example -- java AudioResponsesMappingExample.java
Env
None
RealtimeAudioEventsExample.java
Grok and Gemini realtime event folding
Commandnpm run example -- java RealtimeAudioEventsExample.java
Env
None
Agent and RLM examples
AxAgentPipelineExample.java
Deterministic AxAgent forward and logs
Commandnpm run example -- java AxAgentPipelineExample.java
Env
None
RuntimeAdapterExample.java
Custom AxCodeRuntime session
Commandnpm run example -- java RuntimeAdapterExample.java
Env
None
AxMCPScriptedToolsExample.java
MCP scripted transport tools
Commandnpm run example -- java AxMCPScriptedToolsExample.java
Env
None
Flow examples
AxFlowProgramGraphExample.java
Deterministic AxFlow graph
Commandnpm run example -- java AxFlowProgramGraphExample.java
Env
None
Optimization examples
OptimizerArtifactExample.java
Optimizer artifact apply round trip
Commandnpm run example -- java OptimizerArtifactExample.java
Env
None
GEPALocalOptimizerExample.java
Local GEPA engine run
Commandnpm run example -- java GEPALocalOptimizerExample.java
Env
None
Other examples
SignatureSchemaExample.java
Signature and schema smoke
Commandnpm run example -- java SignatureSchemaExample.java
Env
None
AxGenScriptedClientToolExample.java
AxGen scripted client and tool
Commandnpm run example -- java AxGenScriptedClientToolExample.java
Env
None
How To Read These
No keyexamples use scripted clients, protocol adapters, or generated package tests.Provider APIexamples make real HTTP calls and list the environment variables they normally need.- Generated language examples live under each package’s
examplesdirectory. - TypeScript examples live under
src/examples.
Source
- Catalog:
npm run example -- list/scripts/run-example.mjs - Files:
packages/java/examples