Documentation / @agentick/nestjs

@agentick/nestjs

NestJS integration for Agentick with multiplexed SSE sessions.

Installation

pnpm add @agentick/nestjs

Quick Start

import { Module } from "@nestjs/common";
import { AgentickModule } from "@agentick/nestjs";
import { createApp } from "@agentick/core";

@Module({
  imports: [
    AgentickModule.forRoot({
      app: createApp(<MyAgent />),
    }),
  ],
})
export class AppModule {}

Default Endpoints

Method	Path	Description
GET	/events	SSE stream
POST	/send	Send and stream
POST	/subscribe	Subscribe to sessions
POST	/abort	Abort execution
POST	/close	Close session
POST	/tool-response	Submit tool confirmation
POST	/channel	Publish to channel

Custom Controller

@Module({
  imports: [
    AgentickModule.forRoot({
      app,
      registerController: false,
    }),
  ],
  controllers: [ChatController],
})
export class AppModule {}

@Controller("chat")
export class ChatController {
  constructor(private agentick: AgentickService) {}

  @Post("send")
  async send(@Body() body: SendDto, @Res() res: Response) {
    await this.agentick.sendAndStream(body.sessionId, body, res);
  }
}

AgentickService

service.createConnection(res)             // SSE connection
service.subscribe(connId, sessionIds)     // Subscribe
service.unsubscribe(connId, sessionIds)   // Unsubscribe
service.sendAndStream(sessionId, input, res)  // Send and stream
service.abort(sessionId, reason?)         // Abort
service.close(sessionId)                  // Close
service.publishToChannel(sessionId, channel, type, payload)  // Channel pub
service.getApp()                          // Direct App access

Inject App Directly

@Injectable()
export class MyService {
  constructor(@Inject(TENTICKLE_APP) private app: App) {
    const session = this.app.session("conv-123");
  }
}

@agentick/nestjs - NestJS adapter for Agentick Gateway

Provides NestJS integration that delegates to Gateway. This is a thin adapter - all business logic lives in @agentick/gateway.

Examples

import { Module } from '@nestjs/common';
import { AgentickModule } from '@agentick/nestjs';
import { createApp } from '@agentick/core';

@Module({
  imports: [
    AgentickModule.forRoot({
      apps: { assistant: createApp(<MyAgent />) },
      defaultApp: "assistant",
    }),
  ],
})
export class AppModule {}
// Endpoints: GET /events, POST /send, POST /invoke, etc.

import { AgentickModule, method } from '@agentick/nestjs';
import { z } from "zod";

@Module({
  imports: [
    AgentickModule.forRoot({
      apps: { assistant: myApp },
      defaultApp: "assistant",
      methods: {
        tasks: {
          list: method({
            schema: z.object({ sessionId: z.string() }),
            handler: async (params) => todoService.list(params.sessionId),
          }),
        },
      },
    }),
  ],
})
export class AppModule {}

Default Endpoints

Method	Path	Description
GET	/events	SSE stream
POST	/send	Send and stream
POST	/invoke	Invoke custom method
POST	/subscribe	Subscribe to sessions
POST	/abort	Abort execution
POST	/close	Close session

Classes

• AgentickController
• AgentickModule
• AgentickService

Interfaces

• GatewayConfig
• MethodDefinition

Type Aliases

• AgentickModuleOptions
• AuthConfig

Variables

• TENTICKLE_GATEWAY

Functions

• method