Core API map

July 20, 2026 ยท View on GitHub

Audience: developers choosing the typed Java client.
Reference policy: generated Javadocs are canonical for signatures; source links are useful for snapshot development.

NeedTypeModuleRoute
Configure HTTP/auth transportConductorClient / ApiClientcoreJavadocs
Start, query, pause, resume workflowsWorkflowClientcoresource
Poll and update tasksTaskClientcoresource
Register task and workflow metadataMetadataClientcoresource
Create schedulesSchedulerClientcore/Orkes clientssource
Manage schemasSchemaClientcore/Orkes clientssource
Transfer workflow-scoped filesFileClientcoreguide
Emit SDK metricsmetrics integrationmetricsREADME
Compile, deploy, start, signal, and stream agentsAgentClientcore + AIreference
Build/serve/run agentsAgentRuntimeAIreference

OrkesClients assembles Orkes-specific typed clients from the shared transport. Use connection and authentication before constructing any client.

Next: workflows, agents, and compatibility.