API reference

Platform operator

Munim operator routes: tenants, country packs, plans, flags, budgets and model roles, changed through approved config drafts.

post

/platform/v1/network-snapshots

Mint the network impact snapshot (operator template platform.cares_network_impact); nothing is public until a config draft publishes it

operationId mintCaresNetworkSnapshot

Auth

Operator token

Request body

CaresNetworkSnapshotMintcontract cares.network-snapshot-mint
  • template_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • paramsmap of one of 4 | nullrequired

Response 201

PlatformCaresNetworkSnapshotcontract platform.cares-network-snapshot
  • snapshot_idUuid7required
  • template_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • template_versionintegerrequired
    ≥ 1≤ 9007199254740991
  • paramsmap of one of 4 | nullrequired
  • columnsarray of objectrequired
    • namestringrequired
      pattern ^[a-z_][a-z0-9_]*$
    • typeenum (7)required
      integernumerictextdatetimestamptzbooleanuuid
    • numeric_sourceone of 2 | nulloptional
  • rowsarray of map of one of 3 | nullrequired
    max items 500
  • row_countintegerrequired
    ≥ 0≤ 500
  • sha256stringrequired
    pattern ^[0-9a-f]{64}$
  • created_atIsoDatetimerequired
  • minted_by_operator_idUuid7required
  • published_atIsoDatetime | nullrequired
  • publish_draft_idUuid7 | nullrequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/budgets/{tenant}/spend

A tenant's monthly AI budget and spend rows for one UTC month (default the current), newest first; operator only

operationId getTenantSpend

Auth

Operator token

Parameters

  • tenantin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
  • monthin querystringoptional
    pattern ^\d{4}-(0[1-9]|1[0-2])-01$

Response 200

PlatformTenantSpendcontract platform.tenant-spend
  • tenant_idUuid7required
  • monthsarray of objectrequired
    • monthstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • limit_minorintegerrequired
      ≥ 0≤ 9007199254740991
    • spent_minorintegerrequired
      ≥ 0≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$
  • rowsarray of objectrequired
    • atIsoDatetimerequired
    • amount_minorintegerrequired
      ≥ 0≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$
  • has_morebooleanrequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/tenants

Tenants from platform.tenant_registry (no tenant business data)

operationId listTenants

Auth

Operator token

Response 200

PlatformTenantscontract platform.tenants

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/country-packs/{code}/{version}

One country pack version with its document

operationId getCountryPack

Auth

Operator token

Parameters

  • codein pathstringrequired
  • versionin pathstringrequired

Response 200

PlatformCountryPackDetailcontract platform.country-pack-detail
  • codestringrequired
    pattern ^[A-Z]{2}$
  • versionintegerrequired
    ≥ 1≤ 9007199254740991
  • effective_fromstring (date)required
    pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
  • statusenum (3)required
    draftactiveretired
  • created_atIsoDatetimerequired
  • docmap of anyrequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/budgets

Per-tenant monthly AI budgets with spent from platform.llm_budget_spent

operationId listBudgets

Auth

Operator token

Response 200

PlatformBudgetscontract platform.budgets

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/config-drafts

Config drafts (status: proposed (default) | applied | rejected | stale | all)

operationId listConfigDrafts

Auth

Operator token

Parameters

  • statusin queryenum (5)optional
    proposedappliedrejectedstaleall

Response 200

PlatformConfigDraftscontract platform.config-drafts

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/config-drafts

Propose a platform config change (nothing applies until approved)

operationId proposeConfigDraft

Auth

Operator token

Request body

PlatformConfigDraftProposecontract platform.config-draft-propose
  • draft_idUuid7optional
  • targetstringrequired
    pattern ^[a-z_]+(:[A-Za-z0-9_.-]+)?$
  • patchmap of anyrequired

Response 201

PlatformConfigDraftcontract platform.config-draft
  • idUuid7required
  • targetstringrequired
  • patchmap of anyrequired
  • beforemap of any | nullrequired
  • statusenum (4)required
    proposedappliedrejectedstale
  • proposed_bystringrequired
  • decided_byUuid7 | nullrequired
  • decided_atIsoDatetime | nullrequired
  • reasonstring | nullrequired
  • created_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

get

/platform/v1/config-drafts/{id}

One config draft (404 for an unknown id)

operationId getConfigDraft

Auth

Operator token

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response 200

PlatformConfigDraftcontract platform.config-draft
  • idUuid7required
  • targetstringrequired
  • patchmap of anyrequired
  • beforemap of any | nullrequired
  • statusenum (4)required
    proposedappliedrejectedstale
  • proposed_bystringrequired
  • decided_byUuid7 | nullrequired
  • decided_atIsoDatetime | nullrequired
  • reasonstring | nullrequired
  • created_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/config-drafts/{id}:approve

Approve and apply a config draft (an operator's own command is its approval, R27)

operationId approveConfigDraft

Auth

Operator token

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

PlatformConfigDraftApprovecontract platform.config-draft-approve
  • reasonstring | nulloptional
    min length 1max length 500

Response 200

PlatformConfigDraftcontract platform.config-draft
  • idUuid7required
  • targetstringrequired
  • patchmap of anyrequired
  • beforemap of any | nullrequired
  • statusenum (4)required
    proposedappliedrejectedstale
  • proposed_bystringrequired
  • decided_byUuid7 | nullrequired
  • decided_atIsoDatetime | nullrequired
  • reasonstring | nullrequired
  • created_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/config-drafts/{id}:reject

Reject a config draft with a reason

operationId rejectConfigDraft

Auth

Operator token

Parameters

  • idin pathstringrequired
    pattern ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

PlatformConfigDraftRejectcontract platform.config-draft-reject
  • reasonstringrequired
    min length 1max length 500

Response 200

PlatformConfigDraftcontract platform.config-draft
  • idUuid7required
  • targetstringrequired
  • patchmap of anyrequired
  • beforemap of any | nullrequired
  • statusenum (4)required
    proposedappliedrejectedstale
  • proposed_bystringrequired
  • decided_byUuid7 | nullrequired
  • decided_atIsoDatetime | nullrequired
  • reasonstring | nullrequired
  • created_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/snapshots

Mint an operator snapshot of an operator-level template (R40 C4)

operationId mintOperatorSnapshot

Auth

Operator token

Request body

PlatformSnapshotMintcontract platform.snapshot-mint
  • tenant_idUuid7required
  • template_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • paramsmap of one of 4 | nullrequired

Response 201

Snapshotcontract snapshot
  • snapshot_idUuid7required
  • template_idstringrequired
    pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
  • paramsmap of one of 4 | nullrequired
  • run_idUuid7 | nullrequired
  • minted_by_member_idUuid7 | nullrequired
  • minted_by_operator_idUuid7 | nullrequired
  • outlet_scopeone of 2required
  • columnsarray of objectrequired
    • namestringrequired
      pattern ^[a-z_][a-z0-9_]*$
    • typeenum (7)required
      integernumerictextdatetimestamptzbooleanuuid
    • numeric_sourceone of 2 | nulloptional
  • rowsarray of map of one of 3 | nullrequired
    max items 500
  • row_countintegerrequired
    ≥ 0≤ 500
  • sha256stringrequired
    pattern ^[0-9a-f]{64}$
  • created_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/tenants:provision

tenancy.provision.v1 — operator provisions a tenant (03-architecture §1.9)

operationId provisionTenant

Auth

Operator token

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "tenancy.provision.v1"required
  • payloadTenancyProvisionV1required

Response 201

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.

post

/platform/v1/demo-sessions

demo.session.start.v1 — operator starts an ephemeral judge session on a fresh demo tenant

operationId startDemoSession

Auth

Operator token

Request body

object
  • command_idUuid7required
  • idempotency_keystringrequired
    pattern ^[A-Za-z0-9_.:-]{8,100}$
  • typeconst "demo.session.start.v1"required
  • payloadDemoSessionStartV1required

Response 201

CommandResultcontract command-result
  • command_idUuid7required
  • typestringrequired
    pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+\.v[1-9][0-9]*$
  • entity_idUuid7required
  • committed_atIsoDatetimerequired

Errors

Every error body carries a code, a message and, where it applies, a reason_code. All error and reason codes.