Class OrchestrationNamespace

Methods

cancelWorkflowRun

cancelWorkflowRun(runId: string): Promise<{ run_id: string; status: string }>
POST /api/orchestration/runs/:runId/cancel — Cancel an in-progress run.
Parameters
- runId: string
Returns Promise<{ run_id: string; status: string }>
- Defined in src/core/namespaces/orchestration.ts:114

checkDelegation

checkDelegation(delegationId: string): Promise<DelegationCheckResult>
POST /a2a — Check a delegation's validity (A2A action delegation.check).
Parameters
- delegationId: string
Returns Promise<DelegationCheckResult>
- Defined in src/core/namespaces/orchestration.ts:178

createPattern

createPattern(
params: CreatePatternRequest,
): Promise<{ pattern: OrchestratorPattern; status: string }>
POST /api/orchestration/patterns — Create a new orchestration pattern.
Parameters
- params: CreatePatternRequest
Returns Promise<{ pattern: OrchestratorPattern; status: string }>
- Defined in src/core/namespaces/orchestration.ts:239

createWorkflow

createWorkflow(
req: CreateWorkflowRequest,
): Promise<{ status: string; workflow: WorkflowRecord }>
POST /api/orchestration — Create a workflow with a DAG.
Parameters
- req: CreateWorkflowRequest
Returns Promise<{ status: string; workflow: WorkflowRecord }>
- Defined in src/core/namespaces/orchestration.ts:59

delegateTask

delegateTask(params: DelegateTaskRequest): Promise<DelegationResult>
POST /api/orchestration/delegate — Delegate a task to an agent.
Parameters
- params: DelegateTaskRequest
Returns Promise<DelegationResult>
- Defined in src/core/namespaces/orchestration.ts:135

deleteWorkflow

deleteWorkflow(workflowId: string): Promise<{ deleted: string; ok: boolean }>
DELETE /api/orchestration/:id — Delete a workflow.
Parameters
- workflowId: string
Returns Promise<{ deleted: string; ok: boolean }>
- Defined in src/core/namespaces/orchestration.ts:85

diffIndex

diffIndex(since: Date): Promise<IndexDiffResult>
GET /.well-known/nanda-index/diff?since= — Get agents added/removed/updated since a timestamp.
Parameters
- since: Date
Returns Promise<IndexDiffResult>
- Defined in src/core/namespaces/orchestration.ts:273

getWorkflow

getWorkflow(workflowId: string): Promise<WorkflowDetail>
GET /api/orchestration/:id — Get a single workflow by ID.
Parameters
- workflowId: string
Returns Promise<WorkflowDetail>
- Defined in src/core/namespaces/orchestration.ts:74

getWorkflowStatus

getWorkflowStatus(runId: string): Promise<WorkflowRunStatus>
GET /api/orchestration/runs/:runId — Get workflow run status.
Parameters
- runId: string
Returns Promise<WorkflowRunStatus>
- Defined in src/core/namespaces/orchestration.ts:109

grantDelegation

grantDelegation(params: DelegationGrantRequest): Promise<DelegationGrantResult>
POST /a2a — Issue a scoped delegation grant (A2A action delegation.grant).

The grant is subject to the server-side chain-narrowing invariant: when parent_delegation_id is set, granted_scope must be a subset of the parent's and expires_at must not exceed the parent's TTL. Grants cascade on revoke.
Parameters
- params: DelegationGrantRequest
Returns Promise<DelegationGrantResult>
- Defined in src/core/namespaces/orchestration.ts:156

listConflicts

listConflicts(
params?: ListConflictsParams,
): Promise<{ conflicts: OrchestrationConflict[]; total: number }>
GET /api/orchestration/conflicts — List orchestration conflicts.
Parameters
- params: ListConflictsParams = {}
Returns Promise<{ conflicts: OrchestrationConflict[]; total: number }>
- Defined in src/core/namespaces/orchestration.ts:247

listDelegations

listDelegations(
workflowId: string,
): Promise<{ delegations: DelegationResult[] }>
GET /api/orchestration/delegate?workflow_id= — List delegations for a workflow.
Parameters
- workflowId: string
Returns Promise<{ delegations: DelegationResult[] }>
- Defined in src/core/namespaces/orchestration.ts:141

listPatterns

listPatterns(
options?: ListPatternsOptions,
): Promise<{ patterns: OrchestratorPattern[] }>
GET /api/orchestration/patterns — List orchestration patterns.
Parameters
- options: ListPatternsOptions = {}
Returns Promise<{ patterns: OrchestratorPattern[] }>
- Defined in src/core/namespaces/orchestration.ts:230

listWorkflowRuns

listWorkflowRuns(
workflowId: string,
limit?: number,
): Promise<{ runs: WorkflowRun[] }>
GET /api/orchestration/:id/runs — List runs for a workflow.
Parameters
- workflowId: string
- limit: number = 20
Returns Promise<{ runs: WorkflowRun[] }>
- Defined in src/core/namespaces/orchestration.ts:99

listWorkflows

listWorkflows(
params?: { ownerId?: string; status?: string },
): Promise<{ workflows: WorkflowRecord[] }>
GET /api/orchestration?owner_id=&status= — List workflows.
Parameters
- params: { ownerId?: string; status?: string } = {}
Returns Promise<{ workflows: WorkflowRecord[] }>
- Defined in src/core/namespaces/orchestration.ts:65

raiseConflict

raiseConflict(params: RaiseConflictRequest): Promise<ConflictOutcome>
POST /api/orchestration/conflicts — Raise and resolve a conflict.
Parameters
- params: RaiseConflictRequest
Returns Promise<ConflictOutcome>
- Defined in src/core/namespaces/orchestration.ts:257

revokeDelegation

revokeDelegation(
params: DelegationRevokeRequest,
): Promise<DelegationRevokeResult>
POST /a2a — Revoke a delegation (A2A action delegation.revoke). Cascades to descendants.
Parameters
- params: DelegationRevokeRequest
Returns Promise<DelegationRevokeResult>
- Defined in src/core/namespaces/orchestration.ts:169

routeRequest

routeRequest(params: RouteRequestParams): Promise<RoutingResult>
POST /api/orchestration/route — Route a request to the best-matching agent.
Parameters
- params: RouteRequestParams
Returns Promise<RoutingResult>
- Defined in src/core/namespaces/orchestration.ts:265

runWorkflow

runWorkflow(
workflowId: string,
input?: Record<string, unknown>,
): Promise<WorkflowRunResult>
POST /api/orchestration/:id/runs — Start a new workflow run.
Parameters
- workflowId: string
- Optionalinput: Record<string, unknown>
Returns Promise<WorkflowRunResult>
- Defined in src/core/namespaces/orchestration.ts:91

stats

stats(): Promise<HomeportStats>
GET /stats — Get registry statistics.

Returns Promise<HomeportStats>
- Defined in src/core/namespaces/orchestration.ts:52

streamWorkflowEvents

streamWorkflowEvents(
runId: string,
): AsyncGenerator<Record<string, unknown>, void, unknown>
SSE stream for real-time workflow execution events.
Parameters
- runId: string
Returns AsyncGenerator<Record<string, unknown>, void, unknown>
- Defined in src/core/namespaces/orchestration.ts:122

subscribeToIndex

subscribeToIndex(callback: IndexChangeCallback, intervalMs?: number): () => void
Poll-based index change subscription. Returns an abort function.
Parameters
- callback: IndexChangeCallback
- intervalMs: number = 30_000
Returns () => void
- Defined in src/core/namespaces/orchestration.ts:279

updateWorkflow

updateWorkflow(
workflowId: string,
updates: UpdateWorkflowRequest,
): Promise<{ ok: boolean; workflow: WorkflowRecord }>
PATCH /api/orchestration/:id — Update a workflow.
Parameters
- workflowId: string
- updates: UpdateWorkflowRequest
Returns Promise<{ ok: boolean; workflow: WorkflowRecord }>
- Defined in src/core/namespaces/orchestration.ts:79

Class OrchestrationNamespace

Index

Methods

Methods

cancelWorkflowRun

Parameters

Returns Promise<{ run_id: string; status: string }>

checkDelegation

Parameters

Returns Promise<DelegationCheckResult>

createPattern

Parameters

Returns Promise<{ pattern: OrchestratorPattern; status: string }>

createWorkflow

Parameters

Returns Promise<{ status: string; workflow: WorkflowRecord }>

delegateTask

Parameters

Returns Promise<DelegationResult>

deleteWorkflow

Parameters

Returns Promise<{ deleted: string; ok: boolean }>

diffIndex

Parameters

Returns Promise<IndexDiffResult>

getWorkflow

Parameters

Returns Promise<WorkflowDetail>

getWorkflowStatus

Parameters

Returns Promise<WorkflowRunStatus>

grantDelegation

Parameters

Returns Promise<DelegationGrantResult>

listConflicts

Parameters

Returns Promise<{ conflicts: OrchestrationConflict[]; total: number }>

listDelegations

Parameters

Returns Promise<{ delegations: DelegationResult[] }>

listPatterns

Parameters

Returns Promise<{ patterns: OrchestratorPattern[] }>

listWorkflowRuns

Parameters

Returns Promise<{ runs: WorkflowRun[] }>

listWorkflows

Parameters

Returns Promise<{ workflows: WorkflowRecord[] }>

raiseConflict

Parameters

Returns Promise<ConflictOutcome>

revokeDelegation

Parameters

Returns Promise<DelegationRevokeResult>

routeRequest

Parameters

Returns Promise<RoutingResult>

runWorkflow

Parameters

Returns Promise<WorkflowRunResult>

stats

Returns Promise<HomeportStats>

streamWorkflowEvents

Parameters

Returns AsyncGenerator<Record<string, unknown>, void, unknown>

subscribeToIndex

Parameters

Returns () => void

updateWorkflow

Parameters

Returns Promise<{ ok: boolean; workflow: WorkflowRecord }>

Settings

On This Page