Skip to content

Validate Propose action (dry-run)

POST
/v1/actions/hospitality.action.propose_action/validate
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.propose_action/validate \
--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 }'

Dry-run of apply_hospitality_action_propose_action’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
"parameters": {
"additionalProperty": {
"result": "valid"
}
},
"result": "valid"
}