Skip to content
docs/API reference/AutomationService

AutomationService

The AutomationService methods and their request and response messages.

Generated from automation.proto. Every method is POST /rpc/engram.app.v1.AutomationService/<Method> with a JSON or protobuf body and an x-api-key header.

Method Request Response
ListAutomations ListAutomationsRequest ListAutomationsResponse
GetAutomation GetAutomationRequest GetAutomationResponse
CreateAutomation CreateAutomationRequest CreateAutomationResponse
DraftAutomation DraftAutomationRequest DraftAutomationResponse
SaveVersion SaveVersionRequest SaveVersionResponse
ListVersions ListVersionsRequest ListVersionsResponse
SetAutomationEnabled SetAutomationEnabledRequest SetAutomationEnabledResponse
UpdateAutomationMeta UpdateAutomationMetaRequest UpdateAutomationMetaResponse
SetInputs SetInputsRequest SetInputsResponse
SetBlockOverrides SetBlockOverridesRequest SetBlockOverridesResponse
DuplicateAutomation DuplicateAutomationRequest DuplicateAutomationResponse
ArchiveAutomation ArchiveAutomationRequest ArchiveAutomationResponse
TestRender TestRenderRequest TestRenderResponse
DryRun DryRunRequest DryRunResponse
EvalCode EvalCodeRequest EvalCodeResponse
RunNow RunNowRequest RunNowResponse
ListEventSamples ListEventSamplesRequest ListEventSamplesResponse
ListInputKeyOptions ListInputKeyOptionsRequest ListInputKeyOptionsResponse
ListEventCatalog ListEventCatalogRequest ListEventCatalogResponse
ListActionCatalog ListActionCatalogRequest ListActionCatalogResponse
Field Type
id string
label string
description string
input_schema_json string
Field Type
id string
Field Type
automation Automation
Field Type
id string
name string
description string
kind string
builtin_key string (optional)
enabled bool
current_version int32
inputs_json string
block_overrides_json string
archived bool
created_by_user_id string (optional)
next_fire_at string (optional)
last_fired_at string (optional)
draft_session_id string (optional)
created_at string
updated_at string
version AutomationVersion
Field Type
id string
automation_id string
version int32
status string
error string (optional)
trigger_source string
event_key string (optional)
delivery_key string (optional)
dry_run bool
started_at string (optional)
ended_at string (optional)
created_at string
instance_id string
Field Type
automation Automation
trigger_summary string
last_run AutomationRunBrief (optional)
runs_7d repeated DayRunCount
Field Type
automation_id string
number int32
definition_json string
created_by_user_id string (optional)
created_at string
Field Type
block_id string
field string
code string
message string
Field Type
block_id string
block_type string
rendered_json string
filter_pass bool (optional)
scope_json string
Field Type
name string
description string
enabled bool
definition_json string
inputs_json string
Field Type
automation Automation
Field Type
day string
completed int32
failed int32
filtered int32
other int32
Field Type
prompt string
profile_id string
idempotency_key string
harness string (optional)
model string (optional)
model_router string (optional)
effort string (optional)
harness_mode string (optional)
Field Type
automation_id string
session_id string
created bool
Field Type
automation_id string
sample_id string (one of sample)
payload_json string (one of sample)
entrypoint_id string (optional)
Field Type
run_id string
Field Type
automation_id string
name string (optional)
Field Type
automation Automation
Field Type
source string
mode string
input_json string
Field Type
value_json string (optional)
error_name string (optional)
error_message string (optional)
error_line int32 (optional)
logs repeated string
duration_ms int64
Field Type
key string
label string
description string
schema_json string
sample_json string
observed bool
hidden bool
Field Type
key string
label string
Field Type
id string
event_key string
payload_json string
received_at string
Field Type
id string (one of lookup)
builtin_key string (one of lookup)
Field Type
automation Automation
Field Type
key string
label string
Field Type
provider string
Field Type
actions repeated ActionCatalogEntry
Field Type
include_archived bool
Field Type
automations repeated AutomationSummary
Field Type
provider string
Field Type
events repeated EventCatalogEntry
scope EventCatalogScope (optional)
variables repeated WebhookVariable
default_connection_id string
Field Type
automation_id string
event_key string (optional)
limit int32
Field Type
samples repeated EventSample
Field Type
noun string
connection_id string (optional)
Field Type
options repeated InputKeyOption
Field Type
automation_id string
Field Type
versions repeated AutomationVersion
Field Type
automation_id string
inputs_json string (optional)
payload_json string (optional)
entrypoint_id string (optional)
instance_key string (optional)
instance_inputs_json string (optional)
Field Type
run_id string
Field Type
automation_id string
definition_json string
Field Type
automation Automation
Field Type
id string
enabled bool
Field Type
automation Automation
Field Type
automation_id string
overrides_json string
Field Type
automation Automation
Field Type
automation_id string
inputs_json string
Field Type
automation Automation
Field Type
automation_id string
draft_definition_json string (optional)
inputs_json string (optional)
sample_id string (one of sample)
payload_json string (one of sample)
scheduled_for string (optional)
entrypoint_id string (optional)
Field Type
blocks repeated BlockRender
errors repeated BlockError
Field Type
id string
name string (optional)
description string (optional)
settings_json string (optional)
Field Type
automation Automation
Field Type
path string
alias string