from retab import Retab
client = Retab()
plan = client.workflows.plan(yaml_definition, workflow_id="wf_abc123")
print(plan.workflow_id)
print(plan.rendered_plan)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const plan = await client.workflows.plan(yamlDefinition, undefined, "wf_abc123");
console.log(plan.workflowId);
console.log(plan.renderedPlan);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
yamlDefinition := `apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
`
plan, err := client.Workflows.Plan(ctx, &retab.WorkflowsPlanParams{
YamlDefinition: yamlDefinition,
WorkflowID: retab.Ptr("wf_abc123"),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(plan.WorkflowID)
fmt.Println(plan.RenderedPlan)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
plan = client.workflows.plan(yaml_definition: yaml_definition, workflow_id: 'wf_abc123')
puts plan.workflow_id
puts plan.rendered_plan
use retab::models::DeclarativeWorkflowRequest;
use retab::resources::workflows::PlanParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let yaml_definition = r#"apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
"#;
let plan = client
.workflows()
.plan(PlanParams {
body: DeclarativeWorkflowRequest::new(yaml_definition),
workflow_id: Some("wf_abc123".to_string()),
})
.await?;
println!("{}", plan.workflow_id);
println!("{}", plan.rendered_plan.as_deref().unwrap_or(""));
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$yamlDefinition = <<<'YAML'
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
YAML;
$plan = $client->workflows()->plan(yamlDefinition: $yamlDefinition, workflowId: 'wf_abc123');
print_r($plan);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var yamlDefinition = """
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
""";
var options = new WorkflowsPlanOptions { YamlDefinition = yamlDefinition };
options.WorkflowId = "wf_abc123";
var plan = await client.Workflows.PlanAsync(options);
Console.WriteLine(plan);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var plan = client.workflows().plan(
"metadata:\n id: source_workflow\n",
null,
"wf_abc123"
);
System.out.println(plan);
}
}
curl -X POST 'https://api.retab.com/v1/workflows/wf_abc123/spec/plan' \
-H "Authorization: Bearer $RETAB_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"yaml_definition": "apiVersion: workflows.retab.com/v1alpha2\nkind: Workflow\nmetadata:\n name: Invoice Workflow\nspec:\n blocks: {}\n edges: []\n"
}'
{
"workflow_id": "<string>",
"block_count": 123,
"edge_count": 123,
"diagnostics": {},
"format_version": "workflows-plan/v1",
"summary": {
"add": 0,
"change": 0,
"destroy": 0,
"replace": 0,
"noop": 0,
"total": 0,
"has_changes": false
},
"resource_changes": [],
"rendered_plan": "No changes. Workflow spec is up to date."
}{
"detail": []
}Workflows
Plan Workflow Spec Against Existing Workflow
Preview applying a declarative YAML spec to an existing workflow draft.
The URL workflow id is the plan target. Any workflow id in the YAML is treated as source context.
POST
/
v1
/
workflows
/
{workflow_id}
/
spec
/
plan
from retab import Retab
client = Retab()
plan = client.workflows.plan(yaml_definition, workflow_id="wf_abc123")
print(plan.workflow_id)
print(plan.rendered_plan)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const plan = await client.workflows.plan(yamlDefinition, undefined, "wf_abc123");
console.log(plan.workflowId);
console.log(plan.renderedPlan);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
yamlDefinition := `apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
`
plan, err := client.Workflows.Plan(ctx, &retab.WorkflowsPlanParams{
YamlDefinition: yamlDefinition,
WorkflowID: retab.Ptr("wf_abc123"),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(plan.WorkflowID)
fmt.Println(plan.RenderedPlan)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
plan = client.workflows.plan(yaml_definition: yaml_definition, workflow_id: 'wf_abc123')
puts plan.workflow_id
puts plan.rendered_plan
use retab::models::DeclarativeWorkflowRequest;
use retab::resources::workflows::PlanParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let yaml_definition = r#"apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
"#;
let plan = client
.workflows()
.plan(PlanParams {
body: DeclarativeWorkflowRequest::new(yaml_definition),
workflow_id: Some("wf_abc123".to_string()),
})
.await?;
println!("{}", plan.workflow_id);
println!("{}", plan.rendered_plan.as_deref().unwrap_or(""));
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$yamlDefinition = <<<'YAML'
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
YAML;
$plan = $client->workflows()->plan(yamlDefinition: $yamlDefinition, workflowId: 'wf_abc123');
print_r($plan);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var yamlDefinition = """
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
""";
var options = new WorkflowsPlanOptions { YamlDefinition = yamlDefinition };
options.WorkflowId = "wf_abc123";
var plan = await client.Workflows.PlanAsync(options);
Console.WriteLine(plan);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var plan = client.workflows().plan(
"metadata:\n id: source_workflow\n",
null,
"wf_abc123"
);
System.out.println(plan);
}
}
curl -X POST 'https://api.retab.com/v1/workflows/wf_abc123/spec/plan' \
-H "Authorization: Bearer $RETAB_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"yaml_definition": "apiVersion: workflows.retab.com/v1alpha2\nkind: Workflow\nmetadata:\n name: Invoice Workflow\nspec:\n blocks: {}\n edges: []\n"
}'
{
"workflow_id": "<string>",
"block_count": 123,
"edge_count": 123,
"diagnostics": {},
"format_version": "workflows-plan/v1",
"summary": {
"add": 0,
"change": 0,
"destroy": 0,
"replace": 0,
"noop": 0,
"total": 0,
"has_changes": false
},
"resource_changes": [],
"rendered_plan": "No changes. Workflow spec is up to date."
}{
"detail": []
}Compute the reconcile plan for a declarative workflow YAML spec against a specific existing workflow draft. This does not mutate workflow state.
The
workflow_id in the URL is the plan target. If the YAML includes metadata.id, Retab treats it as source context and does not use it to choose a different workflow.
from retab import Retab
client = Retab()
plan = client.workflows.plan(yaml_definition, workflow_id="wf_abc123")
print(plan.workflow_id)
print(plan.rendered_plan)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const plan = await client.workflows.plan(yamlDefinition, undefined, "wf_abc123");
console.log(plan.workflowId);
console.log(plan.renderedPlan);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
yamlDefinition := `apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
`
plan, err := client.Workflows.Plan(ctx, &retab.WorkflowsPlanParams{
YamlDefinition: yamlDefinition,
WorkflowID: retab.Ptr("wf_abc123"),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(plan.WorkflowID)
fmt.Println(plan.RenderedPlan)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
plan = client.workflows.plan(yaml_definition: yaml_definition, workflow_id: 'wf_abc123')
puts plan.workflow_id
puts plan.rendered_plan
use retab::models::DeclarativeWorkflowRequest;
use retab::resources::workflows::PlanParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let yaml_definition = r#"apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
"#;
let plan = client
.workflows()
.plan(PlanParams {
body: DeclarativeWorkflowRequest::new(yaml_definition),
workflow_id: Some("wf_abc123".to_string()),
})
.await?;
println!("{}", plan.workflow_id);
println!("{}", plan.rendered_plan.as_deref().unwrap_or(""));
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$yamlDefinition = <<<'YAML'
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
YAML;
$plan = $client->workflows()->plan(yamlDefinition: $yamlDefinition, workflowId: 'wf_abc123');
print_r($plan);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var yamlDefinition = """
apiVersion: workflows.retab.com/v1alpha2
kind: Workflow
metadata:
id: source_workflow
name: Invoice Workflow
spec:
blocks:
start:
type: start_json
label: Input JSON
config:
json_schema:
type: object
edges: []
""";
var options = new WorkflowsPlanOptions { YamlDefinition = yamlDefinition };
options.WorkflowId = "wf_abc123";
var plan = await client.Workflows.PlanAsync(options);
Console.WriteLine(plan);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var plan = client.workflows().plan(
"metadata:\n id: source_workflow\n",
null,
"wf_abc123"
);
System.out.println(plan);
}
}
curl -X POST 'https://api.retab.com/v1/workflows/wf_abc123/spec/plan' \
-H "Authorization: Bearer $RETAB_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"yaml_definition": "apiVersion: workflows.retab.com/v1alpha2\nkind: Workflow\nmetadata:\n name: Invoice Workflow\nspec:\n blocks: {}\n edges: []\n"
}'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Successful Response
A preview of the changes a workflow YAML definition would make, with a per-resource diff and a human-readable rendered_plan.
Available options:
create, update, noop Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I