Skip to content

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 ​

PropertyTypeDescriptionDefined 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.engineEngineEngine instancepackages/express/src/middleware/engine.ts:63
engineContext.executionIdstringUnique execution IDpackages/express/src/middleware/engine.ts:65
engineContext.inputEngineInputTransformed input for enginepackages/express/src/middleware/engine.ts:75
engineContext.metadata?Record<string, unknown>Additional metadatapackages/express/src/middleware/engine.ts:77
engineContext.sessionId?stringSession ID for channel routingpackages/express/src/middleware/engine.ts:69
engineContext.tenantId?stringTenant IDpackages/express/src/middleware/engine.ts:73
engineContext.threadIdstringThread/conversation IDpackages/express/src/middleware/engine.ts:67
engineContext.transport?SSETransportTransport (if withTransport middleware used)packages/express/src/middleware/engine.ts:79
engineContext.userIdstringUser IDpackages/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.executionIdstring-packages/server/src/execution-context.ts:217
engineContext.withContext.metadata.sessionIdstring | undefined-packages/server/src/execution-context.ts:216
engineContext.withContext.metadata.tenantIdstring | undefined-packages/server/src/execution-context.ts:214
engineContext.withContext.metadata.threadIdstring-packages/server/src/execution-context.ts:215
engineContext.withContext.metadata.userIdstring-packages/server/src/execution-context.ts:213
engineContext.withContext.user{ id: string; }-packages/server/src/execution-context.ts:211
engineContext.withContext.user.idstring-packages/server/src/execution-context.ts:211

Released under the MIT License.