Replace an AutomationGraph document

curl --request PATCH \
  --url https://api.checkfu.com/v1/automation-graphs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "expected_revision": 1,
  "document": {
    "name": "<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>"
      }
    ]
  }
}
'

import requests

url = "https://api.checkfu.com/v1/automation-graphs/{id}"

payload = {
    "expected_revision": 1,
    "document": {
        "name": "<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>"
            }
        ]
    }
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_revision: 1,
    document: {
      name: '<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>'}]
    }
  })
};

fetch('https://api.checkfu.com/v1/automation-graphs/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_revision' => 1,
    'document' => [
        'name' => '<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>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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/{id}"

	payload := strings.NewReader("{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("idempotency-key", "<idempotency-key>")
	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.patch("https://api.checkfu.com/v1/automation-graphs/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/automation-graphs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "document": {
    "name": "<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>"
      }
    ]
  },
  "layout": {
    "nodes": [
      {
        "id": "<string>",
        "x": 123,
        "y": 123
      }
    ]
  },
  "created_by_principal_id": "<string>",
  "status": "active",
  "revision": 1,
  "layout_version": 1,
  "applied_revision": 1,
  "bindings": [
    {
      "resource_kind": "automation",
      "resource_id": "<string>",
      "resource_version": 1,
      "subject": "<string>",
      "disposition": "created",
      "management": "reconcile",
      "configuration_fingerprint": "<string>"
    }
  ],
  "latest_application_id": "<string>",
  "active_application_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "archived_at": "<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"
  }
}

Replace an AutomationGraph document

CAS-replaces the whole semantic document under expected_revision and creates a new immutable revision. A hands_to Agent chain is executable dataflow: its first Agent renders the fires prompt from for a webhook and each later Agent receives the exact prior Agent output; then remains static sequencing. Layout and any prior applied revision remain unchanged; Idempotency-Key is required.

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.

PATCH

automation-graphs

{id}

Replace an AutomationGraph document

curl --request PATCH \
  --url https://api.checkfu.com/v1/automation-graphs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "expected_revision": 1,
  "document": {
    "name": "<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>"
      }
    ]
  }
}
'

import requests

url = "https://api.checkfu.com/v1/automation-graphs/{id}"

payload = {
    "expected_revision": 1,
    "document": {
        "name": "<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>"
            }
        ]
    }
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'checkfu-version': '<checkfu-version>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_revision: 1,
    document: {
      name: '<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>'}]
    }
  })
};

fetch('https://api.checkfu.com/v1/automation-graphs/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_revision' => 1,
    'document' => [
        'name' => '<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>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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/{id}"

	payload := strings.NewReader("{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("idempotency-key", "<idempotency-key>")
	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.patch("https://api.checkfu.com/v1/automation-graphs/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/automation-graphs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_revision\": 1,\n  \"document\": {\n    \"name\": \"<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}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "document": {
    "name": "<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>"
      }
    ]
  },
  "layout": {
    "nodes": [
      {
        "id": "<string>",
        "x": 123,
        "y": 123
      }
    ]
  },
  "created_by_principal_id": "<string>",
  "status": "active",
  "revision": 1,
  "layout_version": 1,
  "applied_revision": 1,
  "bindings": [
    {
      "resource_kind": "automation",
      "resource_id": "<string>",
      "resource_version": 1,
      "subject": "<string>",
      "disposition": "created",
      "management": "reconcile",
      "configuration_fingerprint": "<string>"
    }
  ],
  "latest_application_id": "<string>",
  "active_application_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "archived_at": "<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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

idempotency-key

string

required

Required string length: 1 - 255

Path Parameters

string

required

Pattern: ^agph_[0-9a-f]{32}$

Body

application/json

expected_revision

integer

required

Required range: x > 0

document

object

required

Show child attributes

Response

Success

string

required

Pattern: ^agph_[0-9a-f]{32}$

workspace_id

string

required

Pattern: ^wrkspc_[0-9a-f]{32}$

document

object

required

Show child attributes

layout

object

required

Show child attributes

created_by_principal_id

string

required

Pattern: ^prin_[0-9a-f]{32}$

status

enum<string>

required

Available options:

active,

archived

revision

integer

required

Required range: x > 0

layout_version

integer

required

Required range: x > 0

applied_revision

integer | null

required

Required range: x > 0

bindings

object[]

required

Show child attributes

latest_application_id

string | null

required

Pattern: ^agpa_[0-9a-f]{32}$

active_application_id

string | null

required

Pattern: ^agpa_[0-9a-f]{32}$

created_at

string

required

updated_at

string

required

archived_at

string | null

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Replace an AutomationGraph document

Authorizations

Headers

Path Parameters

Body

Response