Read Federated output

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.federated_output/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.federated_output/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

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

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.federated_output: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.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

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

Example

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

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).