Skip to content

AI Config Surface

Status: Admitted, in build-out

The SDK AI config surface contract (.nimi/spec/sdks/kernel/ai-config-surface-contract.md) is admitted. It pins how app developers configure AI profiles via SDK; the developer-facing surface is in active build-out.

What This Surface Does

The AI Config Surface is the SDK boundary where an app developer binds AI profile configuration to a scope. It pairs with:

The SDK side is the typed config / profile / snapshot API apps call to apply profiles, probe, and inspect snapshots.

Method Families

FamilyPurpose
Profile applyApply a profile to an AIScopeRef (copy-on-write into the scope's AIConfig)
Profile resolveResolve the effective AIConfig for a scope
Probe (static / availability / feasibility)Validate before execution
Snapshot readRead execution evidence per K-AIEXEC-003

Boundary

OwnsDoes NOT own
Typed config / profile / snapshot APIAIProfile portable schema definition
Scope parameter shapeScope-owner AIConfig intent
Probe surface for callersLocalProfileDescriptor execution (Runtime)

The SDK is the typed access surface. The scope owner owns AIConfig intent; Runtime owns local facts, readiness, and execution evidence.

Reader Scenario: App Applies An AI Profile

App wants to apply a profile to an app-owned workspace.

  1. App calls SDK. aiConfig.applyProfile({ scope: { kind: 'app', ownerId: 'nimi.example-app', surfaceId: 'workspace' }, profile }).
  2. SDK validates. Scope identity per AIScopeRef rules.
  3. Scope owner performs profile apply. Copy-on-write into the workspace scope's AIConfig.
  4. Subsequent execution under the new profile.

What This Does Not Do

  • It does not let apps invent scope kinds.
  • It does not let apps materialize AIConfig directly bypassing profile apply.
  • It does not let apps consume AIScopeRef from another scope's config as runtime fallback.

Source Basis

Nimi AI open world platform documentation.