Skip to content

Use Coordinator API

Coordinator is served on port 4000. It owns agent runtime state and delegation graph state.

MethodPathPurpose
GET/healthLiveness check.
GET/readyDependency and job readiness.
GET/metricsService metrics.
MethodPathPurpose
POST/zones/:zoneId/agentsCreate an agent session.
GET/zones/:zoneId/agentsList agent sessions.
GET/zones/:zoneId/agents/:idInspect one session.
GET/zones/:zoneId/agents/:id/childrenList child sessions.
PATCH/zones/:zoneId/agents/:id/suspendSuspend a session subtree.
PATCH/zones/:zoneId/agents/:id/resumeResume a suspended session subtree.
DELETE/zones/:zoneId/agents/:idTerminate a session.
MethodPathPurpose
POST/zones/:zoneId/agent-servicesRegister or update a service agent.
GET/zones/:zoneId/agent-servicesList service agents.
POST/zones/:zoneId/agents/:id/heartbeatRefresh a service-agent lease.
POST/zones/:zoneId/invocationsCreate an invocation.
GET/zones/:zoneId/invocations/:idInspect an invocation.
PATCH/zones/:zoneId/invocations/:id/startMark an invocation running.
PATCH/zones/:zoneId/invocations/:id/cancelCancel an invocation.
PATCH/zones/:zoneId/invocations/:id/completeComplete an invocation.
MethodPathPurpose
POST/zones/:zoneId/delegationsCreate a delegation edge.
GET/zones/:zoneId/delegations/activeList active delegation edges.
GET/zones/:zoneId/delegations/inbound/:sessionIdList inbound edges for a session.
GET/zones/:zoneId/delegations/outbound/:sessionIdList outbound edges for a session.
GET/zones/:zoneId/delegations/:id/traverseTraverse a delegation edge.
GET/zones/:zoneId/delegations/:id/impactCompute revocation impact.
GET/zones/:zoneId/agents/:sessionId/effective-authorityCompute effective authority for a session.
PATCH/zones/:zoneId/delegations/:id/revokeRevoke delegated authority.
MethodPath
POST/v1/begin
POST/v1/end
POST/v1/spawn-child
POST/v1/exchange
POST/v1/delegate-to-existing-agent
POST/v1/revoke-delegation
POST/v1/verify

SDKs usually call these endpoints through the language-specific Caracal client rather than direct HTTP.

Continue to Use STS Endpoint to see how agent sessions and delegation anchors participate in token exchange.