Read Training cohort

GET

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

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

Read an existing instance.

Append-only record of a single training run’s composition for unlearning + audit. shard_assignment records the SISA shard → tenants map (Bourtoule et al. 2021) so an Article 17 erasure retrains only the affected shards; manifest_hash is the sha256 over the canonicalised manifest. epsilon_budget / delta_budget are recorded, never enforced (proposal 0026 §6).

Authorizations

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

properties

required

object

assembled_at

required

When the cohort was assembled

string format: date-time

delta_budget

DP delta for this run (recorded, not enforced)

string format: decimal

epsilon_budget

DP epsilon for this run (recorded, not enforced)

string format: decimal

exclusion_list_size

required

Count of erased records explicitly excluded from this cohort

integer

required

Cohort id

string

manifest_hash

required

sha256 of the canonicalised cohort manifest

string

model_card_uri

Opaque pointer to the model card (the serving service owns the doc)

string

model_name

required

Model this cohort trained

string

model_version

required

Model version this run produced

integer

run_id

required

MLflow run id (uuid) — the lineage anchor back to training

string

shard_assignment

required

SISA shard id → tenants assigned to that shard

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.training_cohort",
  "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).