curl --request POST \
--url https://api.checkfu.com/v1/automation-graphs/plan-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"document": {
"name": "<string>",
"environment_id": "<string>",
"service_principal_id": "<string>",
"nodes": [
{
"kind": "trigger",
"id": "<string>",
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>"
}
}
],
"edges": [
{
"kind": "fires",
"from": "<string>",
"to": "<string>",
"prompt": "<string>"
}
]
},
"created_by_principal_id": "<string>"
}
'import requests
url = "https://api.checkfu.com/v1/automation-graphs/plan-preview"
payload = {
"document": {
"name": "<string>",
"environment_id": "<string>",
"service_principal_id": "<string>",
"nodes": [
{
"kind": "trigger",
"id": "<string>",
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>"
}
}
],
"edges": [
{
"kind": "fires",
"from": "<string>",
"to": "<string>",
"prompt": "<string>"
}
]
},
"created_by_principal_id": "<string>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
document: {
name: '<string>',
environment_id: '<string>',
service_principal_id: '<string>',
nodes: [
{
kind: 'trigger',
id: '<string>',
trigger: {kind: 'schedule', cron: '<string>', timezone: '<string>'}
}
],
edges: [{kind: 'fires', from: '<string>', to: '<string>', prompt: '<string>'}]
},
created_by_principal_id: '<string>'
})
};
fetch('https://api.checkfu.com/v1/automation-graphs/plan-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checkfu.com/v1/automation-graphs/plan-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'name' => '<string>',
'environment_id' => '<string>',
'service_principal_id' => '<string>',
'nodes' => [
[
'kind' => 'trigger',
'id' => '<string>',
'trigger' => [
'kind' => 'schedule',
'cron' => '<string>',
'timezone' => '<string>'
]
]
],
'edges' => [
[
'kind' => 'fires',
'from' => '<string>',
'to' => '<string>',
'prompt' => '<string>'
]
]
],
'created_by_principal_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checkfu.com/v1/automation-graphs/plan-preview"
payload := strings.NewReader("{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/automation-graphs/plan-preview")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/automation-graphs/plan-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"kind": "planned",
"entries": [
{
"resource": "automation",
"disposition": "create",
"subject": "<string>",
"changes": [
{
"path": "<string>",
"before": null,
"after": null
}
],
"reason": "<string>"
}
],
"counts": {
"automations_created": 1,
"automations_updated": 1,
"automations_paused": 1,
"screens_required": 1,
"permission_assignments_created": 1,
"permission_assignments_reused": 1,
"permission_assignments_revoked": 1,
"blocked": 1
},
"agent_versions_pinned": [
{
"agent": "<string>",
"version": 1
}
],
"required_human_inputs": [
"webhook_ingest_secret"
],
"plan_fingerprint": "<string>",
"document_fingerprint": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Preview an AutomationGraph plan
Dry-runs one unsaved draft document against authenticated live Workspace state with the same server compiler apply uses, and persists nothing: no AutomationGraph, revision, binding, or audit row exists after a preview. Returns resource dispositions, exact managed-field changes, blockers, version pins, required human inputs, a deterministic fingerprint over the draft plan, and the reviewed document fingerprint.
Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.
curl --request POST \
--url https://api.checkfu.com/v1/automation-graphs/plan-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"document": {
"name": "<string>",
"environment_id": "<string>",
"service_principal_id": "<string>",
"nodes": [
{
"kind": "trigger",
"id": "<string>",
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>"
}
}
],
"edges": [
{
"kind": "fires",
"from": "<string>",
"to": "<string>",
"prompt": "<string>"
}
]
},
"created_by_principal_id": "<string>"
}
'import requests
url = "https://api.checkfu.com/v1/automation-graphs/plan-preview"
payload = {
"document": {
"name": "<string>",
"environment_id": "<string>",
"service_principal_id": "<string>",
"nodes": [
{
"kind": "trigger",
"id": "<string>",
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>"
}
}
],
"edges": [
{
"kind": "fires",
"from": "<string>",
"to": "<string>",
"prompt": "<string>"
}
]
},
"created_by_principal_id": "<string>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
document: {
name: '<string>',
environment_id: '<string>',
service_principal_id: '<string>',
nodes: [
{
kind: 'trigger',
id: '<string>',
trigger: {kind: 'schedule', cron: '<string>', timezone: '<string>'}
}
],
edges: [{kind: 'fires', from: '<string>', to: '<string>', prompt: '<string>'}]
},
created_by_principal_id: '<string>'
})
};
fetch('https://api.checkfu.com/v1/automation-graphs/plan-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checkfu.com/v1/automation-graphs/plan-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => [
'name' => '<string>',
'environment_id' => '<string>',
'service_principal_id' => '<string>',
'nodes' => [
[
'kind' => 'trigger',
'id' => '<string>',
'trigger' => [
'kind' => 'schedule',
'cron' => '<string>',
'timezone' => '<string>'
]
]
],
'edges' => [
[
'kind' => 'fires',
'from' => '<string>',
'to' => '<string>',
'prompt' => '<string>'
]
]
],
'created_by_principal_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checkfu.com/v1/automation-graphs/plan-preview"
payload := strings.NewReader("{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/automation-graphs/plan-preview")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/automation-graphs/plan-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_principal_id\": \"<string>\",\n \"nodes\": [\n {\n \"kind\": \"trigger\",\n \"id\": \"<string>\",\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n }\n ],\n \"edges\": [\n {\n \"kind\": \"fires\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ]\n },\n \"created_by_principal_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"kind": "planned",
"entries": [
{
"resource": "automation",
"disposition": "create",
"subject": "<string>",
"changes": [
{
"path": "<string>",
"before": null,
"after": null
}
],
"reason": "<string>"
}
],
"counts": {
"automations_created": 1,
"automations_updated": 1,
"automations_paused": 1,
"screens_required": 1,
"permission_assignments_created": 1,
"permission_assignments_reused": 1,
"permission_assignments_revoked": 1,
"blocked": 1
},
"agent_versions_pinned": [
{
"agent": "<string>",
"version": 1
}
],
"required_human_inputs": [
"webhook_ingest_secret"
],
"plan_fingerprint": "<string>",
"document_fingerprint": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
2026-08-31 Body
Response
Success
- Option 1
- Option 2
planned Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
webhook_ingest_secret ^sha256:[0-9a-f]{64}$^sha256:[0-9a-f]{64}$