Skip to content
aerandil.com
GitHub

Search Agent registry entry

POST
/v1/object-types/hospitality.agent_registry_entry/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.agent_registry_entry/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

Catalog metadata for a first-party or third-party agent, MCP server, or agent skill. Declares maximum action / function / data-class scopes the agent claims to need plus vendor / model / safety metadata. A registry entry is not permission to run — installation enables the agent for a specific tenant / property scope (see agent_installation). The MCP Registry’s server.json is the precedent for storing metadata rather than artifacts; AWS Agent Registry’s curation + approval workflow is the precedent for the review_status gate.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id agent_key publisher version title description registry_source registry_record_uri mcp_server_uri model_provider model_family privacy_url security_url review_status reviewed_by reviewed_at published_at grounding_scope_ref

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.agent_registry_entry
properties
required
object
agent_key
required
Stable registry key (e.g. `io.github.vendor/recovery-agent`)
string
declared_action_scopes
required
Maximum action scopes the agent claims it may need
Array<string>
declared_data_classes
required
Data classes the agent processes
Array<string>
Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets
declared_function_scopes
required
Maximum function scopes the agent claims it may need
Array<string>
declared_read_scopes
Object types the agent reads, each `objects:<object type>:read` naming a registered type. The ceiling an installation's `enabled_read_scopes` is held to; empty or absent declares no narrowed read set.
Array<string>
declared_risk_tiers
required
Risk tiers the agent claims it may take steps under
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 (design D3; runtime owns the grammar)
description
Bounded to 2048 characters
string
grounding_scope_ref
scope_key of the `grounding_scope` injected into the retrieval lane (D11)
string
id
required
Registry entry id
string
mcp_server_uri
Canonical remote MCP endpoint when applicable; HTTPS-only enforced by `mcp_remote_requires_https`
string
model_family
Model family when known (e.g. `claude-opus`, `gpt-5`)
string
model_provider
Model provider when known (e.g. `anthropic`, `openai`)
string
obo_scopes
Execute scopes exercisable on behalf of an invoking user (K5 ceiling)
Array<string>
package_references
required
Agent registry entry package references

Package or artifact references using the source registry’s shape

Array<object>
object
digest
string
name
required
string
registry_type
required
string
uri
string
version
string
privacy_url
Publisher privacy / DPA documentation
string
protocols
required
Protocols the agent supports
Array<string>
Allowed values: mcp openapi webhook sdk a2a custom
published_at
Source publish time
string format: date-time
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
required
Curator review status; only `approved` is installable
string
Allowed values: submitted approved rejected deprecated blocked
reviewed_at
Review timestamp
string format: date-time
reviewed_by
Principal stable id of the reviewer
string
safety_profile
Prompt-injection, data handling, human-review, evaluation metadata
security_url
Security review / SOC2 / vuln disclosure docs
string
title
required
Display name
string
version
required
Agent package / server / skill version
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.agent_registry_entry",
      "properties": {
        "declared_data_classes": [
          "public"
        ],
        "declared_risk_tiers": [
          "read_only"
        ],
        "protocols": [
          "mcp"
        ],
        "registry_source": "aerandil_first_party",
        "review_status": "submitted"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.