@runloop/api-client - v1.18.1
    Preparing search index...

    Class AxonOps

    [Beta] Axon SDK interface for managing axons.

    The AxonOps class provides a high-level abstraction for managing axons, which are event communication channels. Axons support publishing events and subscribing to event streams via server-sent events (SSE).

    This interface is accessed via RunloopSDK.axon. You should construct a RunloopSDK instance and use it from there:

    const runloop = new RunloopSDK();
    const axon = await runloop.axon.create();

    // Publish an event
    await axon.publish({
      event_type: 'task_complete',
      origin: 'AGENT_EVENT',
      payload: JSON.stringify({ result: 'success' }),
      source: 'my-agent',
    });

    // Subscribe to events
    const stream = await axon.subscribeSse();
    for await (const event of stream) {
      console.log(event.event_type, event.payload);
    }
    Index

    Methods

    create fromId list

    Methods

    • [Beta] List all active axons.

      Parameters

      • Optionalparams: Runloop.AxonListParams

        Optional filter/pagination parameters.

      • Optionaloptions: RequestOptions<unknown>

        Request options.

      Returns Promise<RunloopSDK.Axon[]>

      An array of Axon instances.

      const runloop = new RunloopSDK();
      const axons = await runloop.axon.list({ limit: 10 });
      console.log(axons.map((a) => a.id));

    Settings

    Member Visibility

    On This Page

    OverviewUsage
    Methods