Fire an Automation now

curl --request POST \
  --url https://api.checkfu.com/v1/automations/{id}/fire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "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>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.checkfu.com/v1/automations/{id}/fire', 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}/fire",
  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([
    
  ]),
  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/automations/{id}/fire"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", 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.post("https://api.checkfu.com/v1/automations/{id}/fire")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "session_id": "<string>",
  "agent": "<string>",
  "principal": "<string>",
  "requested_by": {
    "kind": "principal",
    "principal": "<string>"
  },
  "acted_as": "<string>",
  "caused_by": {
    "kind": "api",
    "request_id": "<string>"
  },
  "agent_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "trigger": {
    "kind": "api"
  },
  "status": "queued",
  "cost": {
    "tokens": 1,
    "tool_calls": 1,
    "active_ms": 1
  },
  "artifacts": [
    {
      "kind": "file",
      "file": "<string>"
    }
  ],
  "stop_reason": "end_turn",
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "<string>"
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "surface_scope_kind": "root"
}

{
  "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": "model.no_eligible_model",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#model-no-eligible-model"
  }
}

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

{
  "error": {
    "type": "memory.backend_unavailable",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#memory-backend-unavailable"
  }
}

Fire an Automation now

Fire an Automation manually through the same durable AutomationFiring receipt a schedule or webhook uses. There are three 201 success shapes and a client that assumes one will break on the others: an agent target returns the initial Run of a fresh Session, a dream target returns the created Dream, and a dream target whose session selector found nothing new returns the durable { disposition: skipped, reason: no_new_sessions } record. Requires a non-empty Idempotency-Key, unlike pause and resume, which merely accept one.

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.

POST

automations

{id}

fire

Fire an Automation now

curl --request POST \
  --url https://api.checkfu.com/v1/automations/{id}/fire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "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>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.checkfu.com/v1/automations/{id}/fire', 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}/fire",
  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([
    
  ]),
  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/automations/{id}/fire"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", 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.post("https://api.checkfu.com/v1/automations/{id}/fire")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "session_id": "<string>",
  "agent": "<string>",
  "principal": "<string>",
  "requested_by": {
    "kind": "principal",
    "principal": "<string>"
  },
  "acted_as": "<string>",
  "caused_by": {
    "kind": "api",
    "request_id": "<string>"
  },
  "agent_installation_id": "<string>",
  "surface_scope_id": "<string>",
  "trigger": {
    "kind": "api"
  },
  "status": "queued",
  "cost": {
    "tokens": 1,
    "tool_calls": 1,
    "active_ms": 1
  },
  "artifacts": [
    {
      "kind": "file",
      "file": "<string>"
    }
  ],
  "stop_reason": "end_turn",
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "<string>"
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "surface_scope_kind": "root"
}

{
  "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": "model.no_eligible_model",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#model-no-eligible-model"
  }
}

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

{
  "error": {
    "type": "memory.backend_unavailable",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#memory-backend-unavailable"
  }
}

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: ^auto_[0-9a-f]{32}$

Body

application/json

An exact empty JSON object with no named properties.

Response

The initial Run (agent target), the created Dream (dream target), the step-program firing (steps target), or the durable no_new_sessions skip record | an error exactly on failure, an end time exactly on terminal status, and a completed dream always names its output store | AutomationStepProgramFiring

Option 1
Option 2
Option 3
Option 4

The initial Run (agent target), the created Dream (dream target), the step-program firing (steps target), or the durable no_new_sessions skip record

string

required

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

workspace_id

string

required

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

session_id

string

required

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

agent

string

required

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

principal

string

required

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

requested_by

object

required

Option 1
Option 2
Option 3

Show child attributes

acted_as

string

required

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

caused_by

object

required

Show child attributes

agent_installation_id

string | null

required

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

surface_scope_id

string | null

required

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

trigger

object

required

Show child attributes

status

enum<string>

required

Available options:

queued,

running,

requires_action,

completed,

failed,

canceled

cost

object

required

Show child attributes

artifacts

object[]

required

Show child attributes

stop_reason

enum<string> | null

required

Available options:

end_turn,

requires_action,

interrupted,

retries_exhausted,

max_tokens,

max_turn_requests,

refusal,

error,

budget_reached

error

object | null

required

Show child attributes

created_at

string

required

updated_at

string

required

completed_at

string | null

required

surface_scope_kind

enum<string>

Available options:

root,

team,

channel,

personal

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Fire an Automation now

Authorizations

Headers

Path Parameters

Body

Response