Examples Runnable no-key and provider-api examples. java examples examples website/content-src/templates/examples.md example Examples

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

Provider API Java

AxGen OpenAI API run

Command
npm run example -- java AxGenOpenAIExample.java

Env
OPENAI_API_KEY, OPENAI_APIKEY

AgentOpenAIExample.java

Provider API Java

AxAgent OpenAI API run

Command
npm run example -- java AgentOpenAIExample.java

Env
OPENAI_API_KEY, OPENAI_APIKEY

FlowOpenAIExample.java

Provider API Java

AxFlow OpenAI API run

Command
npm run example -- java FlowOpenAIExample.java

Env
OPENAI_API_KEY, OPENAI_APIKEY

LLM, media, and realtime examples

ProviderMappingNoKeyExample.java

No key Java

OpenAI-compatible mapping smoke

Command
npm run example -- java ProviderMappingNoKeyExample.java

Env
None

ProviderStreamNoKeyExample.java

No key Java

OpenAI-compatible streaming smoke

Command
npm run example -- java ProviderStreamNoKeyExample.java

Env
None

AudioResponsesMappingExample.java

No key Java

OpenAI Responses audio mapping

Command
npm run example -- java AudioResponsesMappingExample.java

Env
None

RealtimeAudioEventsExample.java

No key Java

Grok and Gemini realtime event folding

Command
npm run example -- java RealtimeAudioEventsExample.java

Env
None

Agent and RLM examples

AxAgentPipelineExample.java

No key Java

Deterministic AxAgent forward and logs

Command
npm run example -- java AxAgentPipelineExample.java

Env
None

RuntimeAdapterExample.java

No key Java

Custom AxCodeRuntime session

Command
npm run example -- java RuntimeAdapterExample.java

Env
None

AxMCPScriptedToolsExample.java

No key Java

MCP scripted transport tools

Command
npm run example -- java AxMCPScriptedToolsExample.java

Env
None

Flow examples

AxFlowProgramGraphExample.java

No key Java

Deterministic AxFlow graph

Command
npm run example -- java AxFlowProgramGraphExample.java

Env
None

Optimization examples

OptimizerArtifactExample.java

No key Java

Optimizer artifact apply round trip

Command
npm run example -- java OptimizerArtifactExample.java

Env
None

GEPALocalOptimizerExample.java

No key Java

Local GEPA engine run

Command
npm run example -- java GEPALocalOptimizerExample.java

Env
None

Other examples

SignatureSchemaExample.java

No key Java

Signature and schema smoke

Command
npm run example -- java SignatureSchemaExample.java

Env
None

AxGenScriptedClientToolExample.java

No key Java

AxGen scripted client and tool

Command
npm run example -- java AxGenScriptedClientToolExample.java

Env
None

How To Read These

  • No key examples use scripted clients, protocol adapters, or generated package tests.
  • Provider API examples make real HTTP calls and list the environment variables they normally need.
  • Generated language examples live under each package’s examples directory.
  • TypeScript examples live under src/examples.

Source

  • Catalog: npm run example -- list / scripts/run-example.mjs
  • Files: packages/java/examples
Docs