AIDK API Reference / aidk-express / EngineRequest
Interface: EngineRequest ​
Defined in: packages/express/src/middleware/engine.ts:60
Extended request with engine context. Use this type in your handlers.
Extends ​
Request
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
engineContext | { engine: Engine; executionId: string; input: EngineInput; metadata?: Record<string, unknown>; sessionId?: string; tenantId?: string; threadId: string; transport?: SSETransport; userId: string; withContext: { metadata: { executionId: string; sessionId: string | undefined; tenantId: string | undefined; threadId: string; userId: string; }; user: { id: string; }; }; } | - | packages/express/src/middleware/engine.ts:61 |
engineContext.engine | Engine | Engine instance | packages/express/src/middleware/engine.ts:63 |
engineContext.executionId | string | Unique execution ID | packages/express/src/middleware/engine.ts:65 |
engineContext.input | EngineInput | Transformed input for engine | packages/express/src/middleware/engine.ts:75 |
engineContext.metadata? | Record<string, unknown> | Additional metadata | packages/express/src/middleware/engine.ts:77 |
engineContext.sessionId? | string | Session ID for channel routing | packages/express/src/middleware/engine.ts:69 |
engineContext.tenantId? | string | Tenant ID | packages/express/src/middleware/engine.ts:73 |
engineContext.threadId | string | Thread/conversation ID | packages/express/src/middleware/engine.ts:67 |
engineContext.transport? | SSETransport | Transport (if withTransport middleware used) | packages/express/src/middleware/engine.ts:79 |
engineContext.userId | string | User ID | packages/express/src/middleware/engine.ts:71 |
engineContext.withContext | { metadata: { executionId: string; sessionId: string | undefined; tenantId: string | undefined; threadId: string; userId: string; }; user: { id: string; }; } | Pre-built context for engine.execute.withContext() | packages/express/src/middleware/engine.ts:81 |
engineContext.withContext.metadata | { executionId: string; sessionId: string | undefined; tenantId: string | undefined; threadId: string; userId: string; } | - | packages/server/src/execution-context.ts:212 |
engineContext.withContext.metadata.executionId | string | - | packages/server/src/execution-context.ts:217 |
engineContext.withContext.metadata.sessionId | string | undefined | - | packages/server/src/execution-context.ts:216 |
engineContext.withContext.metadata.tenantId | string | undefined | - | packages/server/src/execution-context.ts:214 |
engineContext.withContext.metadata.threadId | string | - | packages/server/src/execution-context.ts:215 |
engineContext.withContext.metadata.userId | string | - | packages/server/src/execution-context.ts:213 |
engineContext.withContext.user | { id: string; } | - | packages/server/src/execution-context.ts:211 |
engineContext.withContext.user.id | string | - | packages/server/src/execution-context.ts:211 |