Register agent

POST

/v1/actions/hospitality.action.register_agent/apply

const url = 'https://api.aerandil.com/v1/actions/hospitality.action.register_agent/apply';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"agent_key":"example","declared_action_scopes":["example"],"declared_data_classes":["public"],"declared_function_scopes":["example"],"declared_read_scopes":["example"],"declared_risk_tiers":["read_only"],"definition_document":{},"description":"example","grounding_scope_ref":"example","mcp_server_uri":"example","model_family":"example","model_provider":"example","obo_scopes":["example"],"package_references":"example","privacy_url":"example","protocols":["mcp"],"publisher":"example","registry_record_uri":"example","registry_source":"aerandil_first_party","review_status":"submitted","safety_profile":"example","security_url":"example","title":"example","version":"example"},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.property"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.register_agent/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "agent_key": "example", "declared_action_scopes": [ "example" ], "declared_data_classes": [ "public" ], "declared_function_scopes": [ "example" ], "declared_read_scopes": [ "example" ], "declared_risk_tiers": [ "read_only" ], "definition_document": {}, "description": "example", "grounding_scope_ref": "example", "mcp_server_uri": "example", "model_family": "example", "model_provider": "example", "obo_scopes": [ "example" ], "package_references": "example", "privacy_url": "example", "protocols": [ "mcp" ], "publisher": "example", "registry_record_uri": "example", "registry_source": "aerandil_first_party", "review_status": "submitted", "safety_profile": "example", "security_url": "example", "title": "example", "version": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Create or supersede an agent_registry_entry version. Registry entries declare the maximum scopes an agent claims to need; only review_status = approved entries are installable (modulo the registry_source = manual operator override). Validators (commit 11): agent_registry_key_version_unique, mcp_remote_requires_https.

Effects: create hospitality.agent_registry_entry.

Authorizations

aerandil_oauth
actions:apply
aerandil_oauth
actions:hospitality.action.register_agent:apply

Request Body^required

application/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

agent_key

required

Stable registry key

string

declared_action_scopes

Maximum action scopes

Array<string>

declared_data_classes

Data classes the agent processes

Array<string>

Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets

declared_function_scopes

Maximum function scopes

Array<string>

declared_read_scopes

Object types the agent reads, as `objects:<object type>:read`

Array<string>

declared_risk_tiers

Risk tiers the agent claims

Array<string>

Allowed values: read_only internal_write guest_message money_movement identity_or_fraud clinical_or_regulated other_high_risk

definition_document

The runtime-interpreted agent definition (JSON; runtime owns the grammar)

object

key

additional properties

any

description

Bounded to 2048 characters

string

grounding_scope_ref

scope_key of the grounding_scope injected into the retrieval lane (D11)

string

mcp_server_uri

Canonical remote MCP endpoint when applicable (HTTPS only)

string

model_family

Model family

string

model_provider

Model provider

string

obo_scopes

Execute scopes exercisable on behalf of a user; must be a subset of the declared action/function scopes (K5)

Array<string>

package_references

Package references (source registry shape)

privacy_url

Privacy / DPA documentation

string

protocols

required

Protocols the agent supports

Array<string>

Allowed values: mcp openapi webhook sdk a2a custom

publisher

required

Vendor / publisher namespace

string

registry_record_uri

Source registry URL / ARN / id

string

registry_source

required

Origin of this registry entry

string

Allowed values: aerandil_first_party mcp_registry aws_agent_registry apaleo_agent_hub private_registry manual

review_status

Curator review status; defaults to submitted

string

Allowed values: submitted approved rejected deprecated blocked

safety_profile

Safety / evaluation metadata

security_url

Security review docs

string

title

required

Display name

string

version

required

Agent version

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

required

string format: uuid

object_type

required

Allowed value: hospitality.property

Responses

200

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

application/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 unlinked properties_updated end_dated

link_type

required

string

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

required

string format: uuid

kind

required

Allowed values: created

object_type

required

Allowed values: hospitality.agent_registry_entry

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"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.agent_registry_entry"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.

Register agent

Authorizations

Request Bodyrequired

Responses

200

Example

409

422

Request Body^required