Skip to content
aerandil.com
GitHub

Search Federated output

POST
/v1/object-types/hospitality.federated_output/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.federated_output/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.

Aggregate artefact from a federated run. Carries cohort summary, privacy guarantee summary, suppression metadata, confidence intervals where applicable, applicability statement, downstream-use restrictions, and (for model artifacts / signal packages) required model card + datasheet refs. Cross-tenant outputs cannot name tenants or properties unless the program is internal portfolio or a consortium policy explicitly permits named publication (proposal 0021 §4.8 / §7).

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 run_id output_kind status output_schema_version artifact_reference artifact_hash applicability_statement downstream_use_restrictions model_card_reference datasheet_reference published_to_scope review_gate_id published_at expires_at quarantined_at quarantine_reason incident_reference

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.federated_output
properties
required
object
applicability_statement
required
What the output can and cannot support
string
artifact_hash
Required when artifact_reference is set
string
artifact_reference
Model artifact, report, or card if stored externally
string
cohort_summary
required
Buckets; not named participants unless internal portfolio output (JSON)
confidence_intervals
Required where output is statistical and meaningful (JSON)
datasheet_reference
Required for model artifacts and benchmark exports
string
downstream_use_restrictions
required
Downstream use restrictions
string
expires_at
Required for model artifacts unless waived
string format: date-time
id
required
Output id
string
incident_reference
External incident ref when quarantined
string
metric_values
Bounded aggregate values; no row-level data (JSON)
model_card_reference
Required for model artifacts and signal packages
string
noise_parameters
Bounded mechanism metadata (JSON)
output_kind
required
Benchmark report / calibration curve / aggregate metric / model artifact / signal package / governance card
string
Allowed values: benchmark_report calibration_curve aggregate_metric model_artifact signal_package governance_card
output_schema_version
required
Output schema version
string
privacy_budget_spend
Actual spend (JSON)
privacy_guarantee_summary
Mechanisms, epsilon / delta, thresholds, suppression (JSON)
publication_evidence
Durable evidence bundle for review gate, budget spend, cohort threshold, suppression, and artifact hash.
published_at
Set by action
string format: date-time
published_to_scope
required
Program owner / participants / public aggregate / specific recipients
string
Allowed values: program_owner participants public_aggregate specific_recipients
quarantine_reason
Bounded
string
quarantined_at
Set by quarantine action
string format: date-time
review_gate_id
Required when output review is required
string
run_id
required
Source run id
string
status
required
Lifecycle status
string
Allowed values: draft reviewing published revoked quarantined expired
suppression_applied
required
True if any metric or slice suppressed
boolean
suppression_reasons
required
Reasons for suppression
Array<string>
Allowed values: minimum_tenants_not_met minimum_properties_not_met minimum_subjects_not_met max_contributor_share_exceeded privacy_budget_exhausted high_variance data_quality_mismatch legal_basis_missing participant_withdrawal reviewer_blocked security_incident
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.federated_output",
      "properties": {
        "output_kind": "benchmark_report",
        "published_to_scope": "program_owner",
        "status": "draft",
        "suppression_reasons": [
          "minimum_tenants_not_met"
        ]
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.