Overview
The Get Workflow Draft endpoint returns the staged draft for a workflow, including its JSON definition and whether it is in sync with the live workflow. Returns404 if no draft exists.
Authentication
Requires a valid API key. No special permission scope is needed beyond a valid key.Key Features
- Sync Indicator:
is_syncedtells you whether the draft differs from the live workflow - Full Draft Shape: Complete JSON definition, name, and description
- No Credit Cost: This endpoint is free to use
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The unique workflow ID |
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
message | string | Human-readable status message |
success | boolean | true on success |
data | object | The draft (see below) |
data object contains:
| Field | Type | Description |
|---|---|---|
id | string | Unique draft identifier |
workflow_id | string | Parent workflow ID |
name | string | Draft name |
description | string | Draft description |
workflow | object | Draft workflow definition (JSON). Same shape as Create Workflow |
last_modified | string | ISO 8601 last modification timestamp |
is_synced | boolean | Whether the draft matches the live workflow |
created | string | ISO 8601 creation timestamp |
Credit Usage
This endpoint is free and does not consume credits.Related Endpoints
- Upsert Workflow Draft to create or update the draft
- Delete Workflow Draft to discard the draft
- Get Workflow to fetch the live workflow for comparison