Skip to content

Publish model version

POST
/v1/actions/hospitality.action.publish_model_version/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.publish_model_version/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "model_card_uri": "example", "model_name": "example", "model_version": 1, "run_id": "example", "training_cohort_id": "example", "training_shard_ids": [ 1 ] }, "return_modified": false }'

Register that a new model version has been published (proposal 0026 §4 step 5). Thin lifecycle emitter — the training run itself is out of scope (§6) — that emits model.version_published with the model identity, the training_cohort_id it was trained from, and the SISA training_shard_ids. Paired with retrain_shard on the revocation-driven unlearning path: a shard retrain bumps the version, which is published here.

Media typeapplication/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
model_card_uri
Opaque pointer to the model card for this version
string
model_name
required
Model whose new version is published (ApiName form)
string
model_version
required
The published model version
integer
run_id
required
MLflow run id (uuid) of the run that produced this version
string
training_cohort_id
required
The training_cohort id this version was trained from
string
training_shard_ids
SISA shard ids that composed this version
Array<integer>
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

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

Media typeapplication/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 unlinked properties_updated end_dated
link_type
required
string
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
id
required
string format: uuid
kind
required
Allowed values: created modified deleted
object_type
required
string
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"
}
],
"modified_objects": [
{
"kind": "created"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.