Inspect federated output privacy

POST

/v1/functions/hospitality.function.inspect_federated_output_privacy/invoke

curl --request POST \
  --url https://api.aerandil.com/v1/functions/hospitality.function.inspect_federated_output_privacy/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "params": { "output_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

• Production API

Return disclosure-control metadata for a published federated output: suppression reasons, privacy guarantee, budget spend, noise parameters, confidence intervals, and publication evidence. The return intentionally excludes metric_values and artifact bodies.

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.inspect_federated_output_privacy:invoke

Request Body^required

Media typeapplication/json

object

params

required

object

output_id

required

Federated output id

string format: uuid

Example^generated

{
  "params": {
    "output_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

Responses

200

Function invoked. The body carries the typed return_value shaped by the function’s declared return_type.

Media typeapplication/json

InvokeFunctionResponse

Envelope returned by the Aerandil function engine. correlation_id is the per-invocation id for trace stitching; return_value is the typed value the function computed (shape declared by the function’s return_type).

object

correlation_id

required

Per-invocation correlation id; appears on log/trace records this function emitted.

string format: uuid

return_value

required

object

confidence_intervals

noise_parameters

output_id

required

string format: uuid

privacy_budget_spend

required

privacy_guarantee_summary

required

publication_evidence

published_at

string format: date-time

review_gate_id

string

status

required

string

Allowed values: draft reviewing published revoked quarantined expired

suppression_applied

required

boolean

suppression_reasons

required

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

Example

{
  "return_value": {
    "status": "draft",
    "suppression_reasons": [
      "minimum_tenants_not_met"
    ]
  }
}

Headers

Cache-Control

string

Always no-store — function results are time-sensitive and never cacheable.

404

Function or target object not found.

422

Parameter validation or domain-rule violation.