---
title: "prepare_workflow_definition"
method: POST
path: "/prepare_workflow_definition"
tags: ["workflow_definition"]
---

# prepare_workflow_definition

`POST /prepare_workflow_definition`

## Request

- Base URL: `https://app.podmule.com/api/v1`
- URL: `https://app.podmule.com/api/v1/prepare_workflow_definition`
- Auth: HTTP bearer

Generic Workflow Builder lifecycle step 1: after the user has confirmed any reusable workflow definition, save it as a disabled prepared workflow, run a real dry run using dry_run_inputs, and return proof for user review. Do not call this before the user has confirmed the reusable definition. After this succeeds, show the dry-run output and ask the user to authorize it with authorize_prepared_workflow.

## Headers

- `Idempotency-Key` string
- `X-PodMule-Dry-Run` 'true' | 'false'

## Request body

- unknown

## Response `200`

Capability output wrapped in `{ data }`.

- object
  - `data` unknown, required

## Other responses

- `400`: Invalid input — Zod validation failed.
- `401`: Missing, malformed, or audience-mismatched bearer token.
- `403`: Token is valid but lacks the required scope.
- `404`: Capability not registered, or referenced resource not found.
- `409`: IDEMPOTENCY_KEY_REUSED — same Idempotency-Key was used previously with a different request body.
- `429`: Rate limit exceeded. Retry after the period in `Retry-After`.
- `500`: Internal error.

---

[API](https://skmtc.dev/podmule/apis/podmule-api.md) · [All operations](https://skmtc.dev/podmule/apis/podmule-api/llms.txt) · [OpenAPI document](https://skmtc.dev/podmule/apis/podmule-api/revisions/844ae61495fa?raw)