Skip to content
aerandil.com
GitHub

Request agent installation

POST
/v1/actions/hospitality.action.request_agent_installation/apply
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.request_agent_installation/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allowed_workflow_keys": [ "example" ], "approval_policy": "example", "auth_mode": "none", "credential_reference": "example", "enabled_action_scopes": [ "example" ], "enabled_data_classes": [ "public" ], "enabled_function_scopes": [ "example" ], "enabled_read_scopes": [ "example" ], "enablement_note": "example", "expires_at": "2026-04-15T12:00:00Z", "installed_scope": "tenant", "installed_scope_ref_object_id": "example", "installed_scope_ref_object_type": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.agent_registry_entry" } }'

Propose an installation of a reviewed registry entry (marketplace-style request-then-approve, proposal 0020 §9.1). Runs the full enable-time validation pipeline but lands the installation at installation_status = requested with no activation stamps; an operator then activates it via enable_agent_installation with installation_id, or denies it via suspend_agent_installation(new_status = revoked). Emits agent_installation.requested.

Effects: create hospitality.agent_installation; link hospitality.link.agent_installation_for_registry_entry.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
allowed_workflow_keys
Optional workflow-key allowlist
Array<string>
approval_policy
Gates required for high-risk steps
auth_mode
required
How the installation authenticates at call time
string
Allowed values: none oauth_client_credentials oauth_delegated api_key_reference jwt_exchange mcp_oauth
credential_reference
Opaque pointer into an external secret manager
string
enabled_action_scopes
Subset of registry entry declared action scopes
Array<string>
enabled_data_classes
Subset of registry entry declared data classes
Array<string>
Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets
enabled_function_scopes
Subset of registry entry declared function scopes
Array<string>
enabled_read_scopes
Subset of registry entry declared read scopes; defaults to all of them
Array<string>
enablement_note
Free-text note
string
expires_at
Optional time-bound install
string format: date-time
installed_scope
required
Tenancy scope this installation grants access at
string
Allowed values: tenant brand portfolio property venue
installed_scope_ref_object_id
Required when installed_scope != tenant
string
installed_scope_ref_object_type
Required when installed_scope != tenant
string
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
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.agent_registry_entry

Responses

Section titled “Responses”

200

Section titled “200”

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.agent_installation_for_registry_entry
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
object_type
required
Allowed values: hospitality.agent_installation
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.agent_installation_for_registry_entry"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.agent_installation"
    }
  ]
}

409

Section titled “409”

Conflict — concurrent modification or unique constraint violation.

422

Section titled “422”

Validation error — parameter validation or business-rule violation.