Workspace Intelligence / JSON Schema

Workspai Workspace Model Snapshot

Defines the versioned workspace model snapshot v1 boundary used by Workspai and its consumers.

Schema version: workspace-model-snapshot.v1
Contract path: contracts/workspace-intelligence/workspace-model-snapshot.v1.json
Publication: embedded-type
Defined fields: 6
Artifact bindings: 1

Why this contract exists

Architecture role

Defines canonical workspace state or a versioned projection of that state.

Consumption boundary

• Workspai CLI
• Workspace Intelligence consumers
• IDEs and agents

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

workspai workspace snapshot

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

Artifact path	Schema	Producer
.workspai/reports/workspace-model-snapshot.json	workspace-model-snapshot.v1	workspai workspace snapshot

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
model	object	Yes	Defines the model value at this contract boundary.	additionalProperties: true
model.schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-model.v1"
modelHash	string	Yes	Defines the modelhash value at this contract boundary.	minLength: 64 · maxLength: 64
modelRef	string	Yes	Defines the modelref value at this contract boundary.	minLength: 1
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "workspace-model-snapshot.v1"

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://getrapidkit.com/schemas/workspace-model-snapshot.v1.json",
  "title": "Workspai Workspace Model Snapshot",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "modelHash",
    "modelRef",
    "model"
  ],
  "properties": {
    "schemaVersion": {
      "const": "workspace-model-snapshot.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "modelHash": {
      "type": "string",
      "minLength": 64,
      "maxLength": 64
    },
    "modelRef": {
      "type": "string",
      "minLength": 1
    },
    "model": {
      "type": "object",
      "required": [
        "schemaVersion"
      ],
      "properties": {
        "schemaVersion": {
          "const": "workspace-model.v1"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}