Class AgencyRegistry

Tracks the Agencies (multi-GMI collectives) active inside the AgentOS runtime.

Remarks

The registry is intentionally ephemeral; durable state should be captured via workflow persistence. For shared memory, use AgencyMemoryManager.

Example

const registry = new AgencyRegistry(logger);

// Create agency with shared memory enabled
const session = registry.upsertAgency({
  workflowId: 'workflow-123',
  conversationId: 'conv-456',
  memoryConfig: { enabled: true },
});

// Register GMI seats
registry.registerSeat({
  agencyId: session.agencyId,
  roleId: 'researcher',
  gmiInstanceId: 'gmi-789',
  personaId: 'research-persona',
});

Constructors

constructor

Methods

upsertAgency getAgency getAgencyByWorkflow listAgencies registerSeat removeAgency appendSeatHistory mergeSeatMetadata

Constructors

constructor

Methods

upsertAgency

  • upsertAgency(args): AgencySession

  • Creates or updates an agency session associated with a workflow.

    Parameters

    • args: AgencyUpsertArgs

      Upsert payload containing workflow linkage, memory config, and optional metadata.

    Returns AgencySession

    The upserted agency session.

    Example

    const session = registry.upsertAgency({
      workflowId: 'workflow-123',
      conversationId: 'conv-456',
      memoryConfig: {
        enabled: true,
        autoIngestCommunications: true,
      },
    });

getAgency

getAgencyByWorkflow

  • getAgencyByWorkflow(workflowId): undefined | AgencySession

  • Resolves the agency session associated with a workflow instance (if any).

    Parameters

    • workflowId: string

      Workflow instance identifier.

    Returns undefined | AgencySession

    The agency session mapped to the workflow, if present.

listAgencies

  • listAgencies(): AgencySession[]

  • Copies of the agency sessions running now, in the order they were created: workflow agencies, and the teams a GMI launched on the full runtime (launch_agency), whose metadata has kind: 'launched'. Each copy's seats, their histories, its metadata and its memory config are copied as far down as they hold arrays and plain objects, so a caller cannot change the registry through them; a value of another kind in a metadata record (a Date, a class instance) is the registry's own.

    Returns AgencySession[]

    The running sessions.

registerSeat

removeAgency

  • removeAgency(agencyId): boolean

  • Removes an agency entirely (e.g., when the workflow reaches a terminal state).

    Parameters

    • agencyId: string

      Agency identifier to remove.

    Returns boolean

    true when the agency existed and was removed.

appendSeatHistory

mergeSeatMetadata

Settings

Member Visibility

Theme

On This Page

constructorupsertAgencygetAgencygetAgencyByWorkflowlistAgenciesregisterSeatremoveAgencyappendSeatHistorymergeSeatMetadata