Get an Automation

curl --request GET \
  --url https://api.checkfu.com/v1/automations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/automations/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/automations/{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/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/automations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/automations/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "version": 1,
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "created_by": "<string>",
  "identity": {
    "acted_as": "<string>"
  },
  "connected_runtime": "<string>",
  "status": "active",
  "paused_reason": {
    "kind": "manual",
    "error_type": "<unknown>"
  },
  "last_run_at": "<string>",
  "last_session_id": "<string>",
  "last_run_id": "<string>",
  "next_run_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "target": {
    "kind": "agent_definition",
    "agent_deployment_id": "<string>",
    "agent_deployment_revision_selection": {
      "type": "current"
    },
    "budget": {
      "limit": 1,
      "metric": "model_tokens"
    }
  },
  "surface_scope_id": "<string>",
  "trigger": {
    "kind": "schedule",
    "cron": "<string>",
    "timezone": "<string>",
    "dedupe_key": "<unknown>",
    "source": "<unknown>",
    "filter": "<unknown>"
  },
  "input": {
    "kind": "snapshot",
    "prompt": "<string>",
    "outcome": {
      "rubric": "<string>",
      "max_iterations": 10,
      "deliverables": [
        "<string>"
      ],
      "report": {
        "extraction": "json",
        "outputs": [
          {
            "key": "<string>",
            "title": "<string>",
            "type": "string",
            "description": "<string>",
            "acceptance": {
              "kind": "one_of",
              "values": [
                "<string>"
              ]
            }
          }
        ]
      }
    },
    "flow_review": {
      "model_routing_profile_key": "<string>",
      "criteria": [
        {
          "key": "<string>",
          "description": "<string>",
          "severity": "low"
        }
      ],
      "tier": "default"
    },
    "mounts": [
      {
        "kind": "project",
        "project_id": "<string>",
        "mount_path": "<string>",
        "revision_policy": {
          "kind": "latest"
        },
        "access": "read_only",
        "writeback": null
      }
    ],
    "prompt_template": "<unknown>"
  },
  "metadata": {}
}

{
  "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": "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"
  }
}

Get an Automation

Read one Automation: its target, trigger, evaluator setup (trigger.filter.check, input.outcome, and optional passive input.flow_review), other input configuration, status with any manual or typed-error paused reason, and scheduler-owned last-firing and next_run_at state. The ingest secret is write-only and never appears here.

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.

GET

automations

{id}

Get an Automation

curl --request GET \
  --url https://api.checkfu.com/v1/automations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/automations/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/automations/{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/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/automations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/automations/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "version": 1,
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "created_by": "<string>",
  "identity": {
    "acted_as": "<string>"
  },
  "connected_runtime": "<string>",
  "status": "active",
  "paused_reason": {
    "kind": "manual",
    "error_type": "<unknown>"
  },
  "last_run_at": "<string>",
  "last_session_id": "<string>",
  "last_run_id": "<string>",
  "next_run_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "target": {
    "kind": "agent_definition",
    "agent_deployment_id": "<string>",
    "agent_deployment_revision_selection": {
      "type": "current"
    },
    "budget": {
      "limit": 1,
      "metric": "model_tokens"
    }
  },
  "surface_scope_id": "<string>",
  "trigger": {
    "kind": "schedule",
    "cron": "<string>",
    "timezone": "<string>",
    "dedupe_key": "<unknown>",
    "source": "<unknown>",
    "filter": "<unknown>"
  },
  "input": {
    "kind": "snapshot",
    "prompt": "<string>",
    "outcome": {
      "rubric": "<string>",
      "max_iterations": 10,
      "deliverables": [
        "<string>"
      ],
      "report": {
        "extraction": "json",
        "outputs": [
          {
            "key": "<string>",
            "title": "<string>",
            "type": "string",
            "description": "<string>",
            "acceptance": {
              "kind": "one_of",
              "values": [
                "<string>"
              ]
            }
          }
        ]
      }
    },
    "flow_review": {
      "model_routing_profile_key": "<string>",
      "criteria": [
        {
          "key": "<string>",
          "description": "<string>",
          "severity": "low"
        }
      ],
      "tier": "default"
    },
    "mounts": [
      {
        "kind": "project",
        "project_id": "<string>",
        "mount_path": "<string>",
        "revision_policy": {
          "kind": "latest"
        },
        "access": "read_only",
        "writeback": null
      }
    ],
    "prompt_template": "<unknown>"
  },
  "metadata": {}
}

{
  "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": "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

Path Parameters

string

required

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

Response

Automation

string

required

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

workspace_id

string

required

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

version

integer

required

Required range: x > 0

name

string

required

Required string length: 1 - 255

description

string | null

required

Required string length: 1 - 4096

external_id

string | null

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

created_by

string

required

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

identity

object

required

Show child attributes

connected_runtime

string | null

required

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

status

enum<string>

required

Available options:

active,

paused

paused_reason

object

required

Option 1
Option 2

Show child attributes

last_run_at

string | null

required

last_session_id

string | null

required

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

last_run_id

string | null

required

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

next_run_at

string | null

required

created_at

string

required

updated_at

string

required

target

object

required

Show child attributes

surface_scope_id

string | null

required

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

trigger

object

required

Show child attributes

input

object

required

Show child attributes

metadata

object

at most 16 correlation pairs with keys of 1 to 64 characters

Show child attributes

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Get an Automation

Authorizations

Headers

Path Parameters

Response