Skip to content

Propose action

POST
/v1/actions/hospitality.action.propose_action/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.propose_action/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "confidence": "low", "context_snapshot": {}, "expires_at": "2026-04-15T12:00:00Z", "rationale_text": "example", "requires_confirmation_from": "guest", "subject_kind": "reservation", "subject_ref": "example", "target_action": "example", "target_params_snapshot": {} }, "return_modified": false }'

An agent creates a proposed_action in proposed state: a frozen, auditable record of a registered action it intends to fire, surfaced for human/guest confirmation. Auto-supersedes a prior proposed record for the same (target_action, subject_ref). Honours target_action_registered, proposer_scope, params_snapshot_required, no_high_risk_payload (§6). Emits proposed_action.proposed.

Effects: create hospitality.proposed_action; modify hospitality.proposed_action; link hospitality.link.proposed_action_superseded_by.

Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
confidence
required
Agent confidence in the proposal
string
Allowed values: low medium high
context_snapshot
required
Frozen context the agent saw (bounded excerpts only)
object
key
additional properties
any
expires_at
When an unconfirmed proposal sweeps to `expired` (default 24h)
string format: date-time
rationale_text
required
Human-readable 'why', surfaced at confirmation time
string
requires_confirmation_from
required
Who must confirm before the kernel fires the action
string
Allowed values: guest staff approval_gate
subject_kind
required
The object class the action targets
string
Allowed values: reservation person folio charge stay venue other
subject_ref
required
Id of the subject object
string
target_action
required
The registered action this proposal intends to fire (ApiName form)
string
target_params_snapshot
required
Frozen proposed parameters for the target action
object
key
additional properties
any
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json
ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object
correlation_id
required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid
modified_links
required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
from_id
required
string format: uuid
from_type
required
string
kind
required
Allowed values: linked
link_type
required
Allowed values: hospitality.link.proposed_action_superseded_by
to_id
required
string format: uuid
to_type
required
string
modified_objects
required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
id
required
string format: uuid
kind
required
Allowed values: created modified
object_type
required
Allowed values: hospitality.proposed_action
warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>
object
message
required

Human-readable summary, suitable for logging or operator-UI surfacing.

string
object_type
required

Object type the warning was raised against.

string
property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string
rule
required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string
Example
{
"modified_links": [
{
"kind": "linked",
"link_type": "hospitality.link.proposed_action_superseded_by"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.proposed_action"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.