> Discover all available pages from the documentation index: https://mastra.zisheng.pro/llms.txt

# Mastra.getWorkflow()

`.getWorkflow()` 方法用于按注册键获取 Workflow。此方法为 Workflow 输入和输出 schema 提供完整的 TypeScript 类型推断。

## 使用示例

```typescript
// Retrieve workflow by its registration key (recommended for type inference)
const workflow = mastra.getWorkflow('testWorkflow')
const run = await workflow.createRun()

// TypeScript will properly infer the input schema type
await run.startAsync({
  inputData: {/* properly typed */},
})
```

## 类型推断

为了获得最佳 TypeScript 支持，请将 Workflow 的**注册键**（将 Workflow 添加到 Mastra 时使用的键）传给 `getWorkflow()`。这样可对以下内容进行完整的类型推断：

- 输入数据 schema
- 输出数据 schema
- 步骤结果

如果需要按 Workflow 的 `id` 属性而非注册键获取，可以使用 `getWorkflowById()`，但请注意类型推断不会同样精确。

## 参数

**id** (`TWorkflowId extends keyof TWorkflows`): 要获取的 Workflow ID。必须是 Mastra 配置中存在的有效 Workflow ID。

**options** (`{ serialized?: boolean }`): 可选配置对象。当 serialized 为 true 时，仅返回 Workflow 名称，而非完整的 Workflow 实例。

## 返回值

**workflow** (`TWorkflows[TWorkflowId]`): 具有指定 ID 的 Workflow 实例。如果未找到该 Workflow，则抛出错误。

## 相关内容

- [Workflow 概览](https://mastra.zisheng.pro/docs/workflows/overview)