Skip to content

Agent Mesh — APIs

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.

AgentRuntimeService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method Path Operation Scope Side effects Idempotency Gateway Summary
GET /runtime/attempts/{attemptId} GetAttemptTimeline factory.runs.read read natural GW-03 Phases, checkpoints, calls (by hash and receipt reference, never content), decisions and the outcome of one attempt.
GET /runtime/attempts/{attemptId}/checkpoints ListCheckpoints factory.runs.read read natural GW-03 Checkpoints with sequence, phase and adapter version; used by operators before a resume decision.
GET /runtime/releases/{releaseId} GetLoadedRelease factory.assets.read read natural GW-03 What this worker verified for a release and against which adapter version.

gRPC (code-first, internal)

gRPC service Method Streaming Visibility Side effects Summary
Runtime Interrupt none internal shared-write Run Control asks the lease holder to stop an attempt (cancellation or revocation); the runtime records the request and reports the observed termination.
Runtime AnswerDecision none internal shared-write Deliver a human answer (input or escalation choice) to a waiting attempt; approvals arrive through ApprovalDecided instead.
Runtime WatchAttempt server internal read Stream phase changes and checkpoints of one attempt to the Studio BFF.

AgentRuntimeWorker

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method Path Operation Scope Side effects Idempotency Gateway Summary
GET /runtime/health RuntimeHealth factory.health.read read natural GW-01 Liveness, readiness (store, silo, control plane reachability, model gateway, tool executor) and capacity of this worker.
GET /runtime/meta/modules RuntimeModules factory.meta.read read natural GW-03 Runtime adapter version, checkpoint format version, loaded modules and supported tool schema versions; used for release compatibility checks.

WorkflowEngineService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method Path Operation Scope Side effects Idempotency Gateway Summary
POST /runtime/workflow-definitions/validate ValidateWorkflowDefinition factory.assets.write sandbox natural GW-03 Validate a workflow DSL document: acyclicity, declared action classes and failure policies, schema references, bounded loops; used by authoring and by publication (BC-04) as a gate.
GET /runtime/workflow-runs/{runId} GetWorkflowRunGraph factory.runs.read read natural GW-03 The graph of a run with the state of every step run, timers and compensation entries, for the Studio run view.
GET /runtime/workflow-definitions/{definitionId}/versions ListWorkflowDefinitionVersions factory.assets.read read natural GW-03 Loaded versions of a definition with graph hashes.

gRPC (code-first, internal)

gRPC service Method Streaming Visibility Side effects Summary
WorkflowEngine PlanNextSteps none internal read Given the run and the last applied outcome sequence return the steps that are ready to dispatch with their input mappings and action classes; idempotent.
WorkflowEngine GetRunGraph none internal read Current engine projection of a run for Run Control and the BFF.