Publish federated output

POST

/v1/actions/hospitality.action.publish_federated_output/apply

const url = 'https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_output/apply';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"applicability_statement":"example","artifact_hash":"example","artifact_reference":"example","cohort_summary":{},"confidence_intervals":"example","datasheet_reference":"example","downstream_use_restrictions":"example","expires_at":"2026-04-15T12:00:00Z","metric_values":"example","model_card_reference":"example","noise_parameters":{},"output_kind":"benchmark_report","output_schema_version":"example","privacy_budget_spend":"example","privacy_guarantee_summary":{},"published_to_scope":"program_owner","review_gate_id":"example"},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.federated_output"}}'
};

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

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.publish_federated_output/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "applicability_statement": "example", "artifact_hash": "example", "artifact_reference": "example", "cohort_summary": {}, "confidence_intervals": "example", "datasheet_reference": "example", "downstream_use_restrictions": "example", "expires_at": "2026-04-15T12:00:00Z", "metric_values": "example", "model_card_reference": "example", "noise_parameters": {}, "output_kind": "benchmark_report", "output_schema_version": "example", "privacy_budget_spend": "example", "privacy_guarantee_summary": {}, "published_to_scope": "program_owner", "review_gate_id": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_output" } }'

Publish a reviewed output. Validates run status and output schema, validates review gate completion where required, validates suppression and privacy metadata, sets status to published. Validators (commit 5): output_publish_requires_run_completed_or_output_review, output_thresholds_satisfied, output_model_artifact_requires_card_and_datasheet, output_review_gate_required_when_definition_says_so, output_no_named_tenants_in_cross_tenant_output.

Effects: modify hospitality.federated_output; modify hospitality.federated_run; link hospitality.link.federated_output_reviewed_by_gate.

Authorizations

aerandil_oauth
actions:apply
aerandil_oauth
actions:hospitality.action.publish_federated_output:apply

Request Body^required

application/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

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 / card if stored externally

string

cohort_summary

required

Buckets; not named participants unless internal portfolio (JSON)

object

key

additional properties

any

confidence_intervals

Required where output is statistical (JSON)

datasheet_reference

Required for model artifacts and benchmark exports

string

downstream_use_restrictions

required

Required

string

expires_at

Required for model artifacts unless waived

string format: date-time

metric_values

Bounded aggregate values (JSON)

model_card_reference

Required for model artifacts and signal packages

string

noise_parameters

Bounded mechanism metadata (JSON)

object

key

additional properties

any

output_kind

required

Output kind

string

Allowed values: benchmark_report calibration_curve aggregate_metric model_artifact signal_package governance_card

output_schema_version

required

Required

string

privacy_budget_spend

required

Committed budget spend (JSON)

privacy_guarantee_summary

required

Mechanisms, epsilon / delta, thresholds (JSON)

object

key

additional properties

any

published_to_scope

required

Output access scope

string

Allowed values: program_owner participants public_aggregate specific_recipients

review_gate_id

Required when output review is required

string

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

required

string format: uuid

object_type

required

Allowed value: hospitality.federated_output

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

application/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.federated_output_reviewed_by_gate

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

required

string format: uuid

kind

required

Allowed values: modified

object_type

required

Allowed values: hospitality.federated_output hospitality.federated_run

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.federated_output_reviewed_by_gate"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.federated_output"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.

Publish federated output

Authorizations

Request Bodyrequired

Responses

200

Example

409

422

Request Body^required