Read Grounding scope

GET

/v1/object-types/hospitality.grounding_scope/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.grounding_scope/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.grounding_scope/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

An admin-curated grounding bundle for agents (design D11): a named subset of object types and metrics, synonym/sample-value hints, curation instructions, and a repository of verified invocations — human-blessed NL→action/metric/function examples with verified_by/verified_at provenance (the Snowflake verified-query pattern). Agent definitions reference one via grounding_scope_ref; the retrieval-context lane injects it deterministically, and answers can cite which verified example grounded them. Referential validity of target_ref against the registry is enforced by the consuming lane at read time, not frozen at write time — the registry evolves under the scope.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.grounding_scope:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.grounding_scope

properties

required

object

defined_at

required

When the scope was defined

string format: date-time

defined_by

`principal.stable_id()` of the curator

string

required

Scope id

string

instructions

Curator instructions injected into the retrieval context

string

metric_refs

required

MetricDef names in scope

Array<string>

object_type_refs

required

Object-type api-names in scope

Array<string>

scope_key

required

Stable key agent definitions reference

string

scope_status

required

Curation lifecycle

string

Allowed values: active retired

synonyms

Term→canonical hints + sample values (JSON; curator-owned shape)

title

required

Display name

string

verified_invocations

required

Grounding scope verified invocations

Human-blessed NL→invocation examples with provenance

Array<object>

object

params_example

target_kind

required

string

Allowed values: action metric function

target_ref

required

string

utterance

required

string

verified_at

required

string format: date-time

verified_by

required

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

Example

{
  "object_type": "hospitality.grounding_scope",
  "properties": {
    "scope_status": "active",
    "verified_invocations": [
      {
        "target_kind": "action"
      }
    ]
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).