Skip to main content
PATCH
Update Automation

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys. User-session JWTs are not accepted by /v1/replica endpoints.

Path Parameters

id
string<uuid>
required

The unique identifier of the automation

Body

application/json

Request body for updating an automation. Only provided fields are updated.

name
string

New name

description
string

New description

triggers
object[]

Replace triggers. Duplicates are not allowed: at most one cron trigger, and at most one event-based trigger per event (e.g. two triggers for pull_request.opened is rejected, but pull_request.opened + merge_request.opened is fine).

prompt
string

New prompt

debounce_seconds
integer | null

Set or clear the per-automation debounce window in seconds. When greater than 0, bursty trigger events update one pending run and the latest payload runs after matching events stop for this many seconds. GitHub and GitLab events keep separate pending runs per repository and pull or merge request. Null or 0 disables debouncing.

Required range: 0 <= x <= 86400
github_check_names
string[]

Set or clear the GitHub check names this automation reports its verdict on. A non-empty list requires a pull_request.opened or pull_request.synchronize trigger. Pass an empty array to stop creating checks.

Maximum array length: 10
Maximum string length: 100
environment_id
string<uuid>

Move this automation to a different environment.

enabled
boolean

Enable or disable the automation

workspace_lifecycle_policy
enum<string>

New lifecycle policy

Available options:
default,
archive_when_done,
sleep_when_done
workspace_auto_stop_minutes
integer | null

New inactivity timeout in minutes for the default keep-alive policy (set to null to clear)

Required range: 3 <= x <= 1440
workspace_size
enum<string>

New compute size for every workspace this automation fires off. small (2 vCPU, 8 GB memory, 20 GB disk) bills at $0.008/min; large (4 vCPU, 16 GB memory, 32 GB disk) bills at $0.016/min.

Available options:
small,
large
config
object

Workspace behavior configuration. Missing capabilities and preferences default to disabled.

agent_provider
enum<string> | null

New coding agent override. Null inherits the organization default.

Available options:
claude,
codex,
cursor,
opencode,
pi,
null
model
string | null

New model override. Requires agent_provider when set.

thinking_level
enum<string> | null

New thinking/reasoning level override. ultra is Codex-only; ultracode is Claude Code-only.

Available options:
low,
medium,
high,
xhigh,
max,
ultra,
ultracode,
null
plan_mode
boolean

Enable or disable plan mode for automation messages.

goal_mode
boolean | null

Enable or disable Codex goal mode for automation messages. Null inherits the resolved agent default; false explicitly disables it.

fast_mode
boolean | null

Enable or disable fast mode for automation messages. Null inherits the resolved agent default; false explicitly disables it.

Response

Automation updated successfully

Response containing a single automation

automation
object
required

An automation record