Exported types and classes

Everything in this index is importable from 'lua-cli'; types and interfaces with import type. The primitive classes themselves (LuaAgent, LuaSkill, LuaJob, LuaWebhook, PreProcessor, PostProcessor, LuaMCPServer, and the define* functions) are listed on the SDK overview. Result shapes that are not exported, such as WorkflowRun, Basket, and JobExecution, are still typed on the method that returns them: name them with Awaited<ReturnType<typeof Workflows.get>> or Parameters<typeof Baskets.addItem>[1]. Verified against lua-cli 3.33.0.

import { BasketStatus, JobInstance } from 'lua-cli';
import type { LuaTool, LuaQuery, ChatHistoryMessage, WorkflowsApi } from 'lua-cli';

Primitives

Area	Exports	Reference
Tools	`LuaTool`, `ToolFlag` (enum)	`LuaTool`
Agent	`LuaAgentConfig`, `LuaAgentModel`, `AgentModelSettings`, `PersonaText`	`LuaAgent`
Webhooks	`LuaWebhookConfig`	`LuaWebhook`
Triggers	`LuaTriggerConfig`, `TriggerContext`	`LuaTrigger`
Shipped jobs	`LuaJobConfig`, `JobSchedule`	`LuaJob`
Preprocessors	`PreProcessorConfig`, `PreProcessorAction`, `PreProcessorResult`, `PreProcessorBlockResponse`, `PreProcessorProceedResponse`, `PreProcessorOverride`	`PreProcessor`
Postprocessors	`PostProcessorConfig`, `PostProcessorResponse`, `PostProcessorOverride`	`PostProcessor`
MCP servers	`LuaMCPServerConfig`, `MCPServerBaseConfig`, `MCPSSEServerConfig`, `MCPStreamableHttpServerConfig`, `MCPTransport`	`LuaMCPServer`
Devices	`LuaDeviceConfig`, `DeviceCommandConfig`, `DeviceTriggerConfig`, `LuaDeviceTriggerConfig`	`defineDevice`
Voice	`LuaVoiceTool` (class), `LuaVoiceConfig`, `LuaVoiceToolConfig`, `LuaVoiceToolCtx`, `LuaVoiceHookContext`, `LuaVoiceTurnContext`	`defineVoice`

Workflow builder

Area	Exports	Reference
Config and builder	`LuaWorkflowConfig`, `LuaWorkflowBuilder`, `LuaWorkflowStep`, `LuaWorkflowBuildCode`, `LuaWorkflowBuildWarning`, `LuaWorkflowBuildError` (class)	Workflow builder
Step context	`WorkflowStepContext`, `WorkflowStepResultError`, `WorkflowStepWorkspace`, `WorkspaceSpec`, `WorkflowWorkspaceBackend`, `WorkflowMergePolicy`	Workflow builder
Exec and shell	`WorkflowExec`, `WorkflowShell`, `WorkflowShellValue`, `WorkflowExecOptions`, `WorkflowExecResult`, `WorkflowExecError`, `WorkflowExecErrorCode`, `WorkflowExecRefusalReason`, `WorkflowExecBinary`	Workflow builder
Step options	`AgentStepOptions`, `SpecialistStepOptions`, `ToolStepOptions`, `NestedWorkflowOptions`, `ApprovalOptions`, `WaitForSignalOptions`, `ForeachOptions`, `LoopOptions`	Workflow builder
Approvals and timeouts	`WorkflowApproverSpec`, `WorkflowFourEyes`, `WorkflowBusinessHours`, `WorkflowSuspendOnTimeout`, `WorkflowSuspendTimeoutChain`, `WorkflowSuspendTimeoutChainMember`, `RetryPolicy`	Workflow builder
Step references	`StepRef`, `StepPathRef`, `ContainerArm`, `TypedRef`, `Literal`, `LuaPredicate`, `DotPath`, `PathValue`	Workflow builder
Bindings	`MapDescriptor`, `LuaMapConfig`, `PathOrLiteral`, `TemplateLike`, `TemplateBinding`, `EnvRefBinding`	Workflow builder
Knowledge, artefacts, datasets	`KnowledgeBindingSpec`, `ArtefactRef`, `DatasetRef`, `WorkflowArtefactMeta`, `JsonSchema`	Workflow builder
Job tier and roles	`WorkflowJobToolId`, `WorkflowJobHarness`, `WorkflowSpecialistRole`, `AgentToolScope`, `WorkflowOutputVisibility`, `ReplyChannel`	Workflow builder
Wire shapes	`SerializedWorkflowGraph`, `WorkflowGoalEnvelope`, `WorkflowRunTrigger`	Workflow builder

Runtime objects

Area	Exports	Reference
Workflows	`WorkflowsApi`	`Workflows`
User	`UserDataInstance` (class), `UserLookupOptions`, `ProfileResponse`	`User`
Conversation	`ChatHistoryMessage`, `ChatHistoryContent`, `ChatMessage`, `TextMessage`, `ImageMessage`, `FileMessage`	`User`
Data	`DataEntryInstance` (class)	`Data`
Lua Query	`LuaQuery`, `LuaQueryFieldOperators`, `LuaQueryScalar`	Lua Query
Products	`ProductInstance` (class)	`Products`
Baskets	`BasketInstance` (class), `BasketStatus` (enum)	`Baskets`
Orders	`OrderInstance` (class), `OrderStatus` (enum)	`Orders`
Dynamic jobs	`JobInstance` (class)	`Jobs`
AI	`AiApi`, `AiGenerateInput`, `AiGenerateOutput`, `AiGenerateStructuredOutput`, `AiGenerateJsonSchema`, `AiGenerateSource`, `AiGenerateToolCall`, `AiGenerateToolResult`	`AI`
Agents	`AgentsApi`	`Agents`
Integrations	`IntegrationsApi`, `IntegrationPassthroughMethod`, `IntegrationPassthroughRequest`, `IntegrationPassthroughResponse`	`Integrations`
Voice runtime	`VoiceApi`	`Voice`
Channels	`ChannelsApi`, `CHANNEL_SEND_CHANNELS` (const), `ChannelSendChannel`, `ChannelSendTarget`, `ChannelSendOptions`, `ChannelSendInput`, `ChannelSendOutput`	`Channels`
Channel payloads	`WhatsAppTemplateSendInput`, `WhatsAppReactionSendInput`, `EmailSendInput`	`Channels`
Deliveries	`DeliveryView`, `DeliveryStatus`, `DeliveryError`, `DeliveryErrorCategory`, `DeliveryListFilter`	`Channels`
Team	`TeamApi`, `DirectoryTarget`, `DirectoryMatch`, `DirectoryResolveResult`	`Team`
WhatsApp message templates	`WhatsAppTemplate`, `WhatsAppTemplateCategory`, `WhatsAppTemplateStatus`, `WhatsAppTemplateComponent`, `PaginatedTemplatesResponse`, `ListTemplatesOptions`, `SendTemplateData`, `SendTemplateValues`, `SendTemplateResponse`	`Templates`
Request context	`LuaRuntime`, `LuaRequest`, `WebhookRequest`, `Channel`	`Lua`

Not exported

These classes and shapes appear in signatures but can’t be imported. Derive them from the member that returns or accepts them.

Shape	Derive with	Reference
`ProductPaginationInstance`, `ProductSearchInstance`	`Awaited<ReturnType<typeof Products.get>>`, `Awaited<ReturnType<typeof Products.search>>`	`Products`
`Basket`, `BasketItem`	`Awaited<ReturnType<typeof Baskets.addItem>>`, `Parameters<typeof Baskets.addItem>[1]`	`Baskets`
`OrderResponse`	`Awaited<ReturnType<typeof Orders.updateStatus>>`	`Orders`
`Job`, `JobVersion`, `JobExecution`	`JobInstance['data']`, `JobInstance['activeVersion']`, `Awaited<ReturnType<JobInstance['trigger']>>`	`Jobs`
`CustomDataEntry`, `GetCustomDataResponse`, `CreateCustomDataOptions`	`Awaited<ReturnType<typeof Data.get>>`, `Parameters<typeof Data.create>[2]`	`Data`
`InboxPushInput`, `InboxPushReceipt`	`Parameters<typeof User.Inbox.push>[0]`, `Awaited<ReturnType<typeof User.Inbox.push>>`	`User.Inbox`
`WorkflowRun`, `WorkflowRunStatus`, `StartWorkflowRunResult`, `CancelRunVerdict`, `ResumeStepResult`, `SignalRunResult`	`Awaited<ReturnType<typeof Workflows.get>>` and the other members	`Workflows`

SDK

CLI

REST API

Exported types and classes

Primitives

Workflow builder

Runtime objects

Not exported

See also

​Primitives

​Workflow builder

​Runtime objects

​Not exported

​See also

Primitives

Workflow builder

Runtime objects

Not exported

See also