ArchAstro. V1. Automations
(archastro v0.2.0)
Copy Markdown
Automation API resource.
Summary
Functions
Invoke an automation
Functions
@spec invoke( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.PostApiV1AutomationsAutomationInvoke.Input.t() ) :: {:ok, ArchAstro.Types.AutomationRun.t()} | {:error, ArchAstro.Error.reason()}
Invoke an automation
Triggers a single run of an automation that has type: "invoked". Returns
the resulting automation run object, which you can use to poll or display
run status.
Both server-to-server (secret key) and user (publishable key + JWT) auth
are supported. The automation's invoke_auth setting controls which auth
modes are accepted; requests using an unsupported mode are rejected with
- For server-to-server callers the run executes under the identity
configured in the automation's
run_as_userorrun_as_agentfields. For authenticated user callers the invoking user's identity is used automatically.
If you supply an idempotency_key, a second request with the same key
returns the existing run rather than creating a new one.
Body fields
payload— free-form invoke input. This is the workflow parameters: validated againstinput_schemawhen configured, stored asevent_payload, and becomes the workflow$after trigger unwrap (e.g.{{$.bug}}for{"bug":"upload fails"}).participants— optional map of symbolic participant refs to agent ids for distributedembed_agentnodes, e.g.{"investigator":"agi_...","evaluator":"agi_..."}. Stored in the run's top-levelparticipantsfield (not inside free-form payload) and exposed to workflows through their system context.
Same top-level payload + participants shape as routine invoke.
The automation run created by this invocation.