Skip to content
aerandil.com
GitHub

Validate Register agent (dry-run)

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

Dry-run of apply_hospitality_action_register_agent’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.

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
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
id
required
string format: uuid
object_type
required
Allowed value: hospitality.property

Responses

Section titled “Responses”

200

Section titled “200”

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"
}