Skip to content

Sensorium Interface Read Request v1

Source schema: doc/schemas/sensorium-interface-read-request.v1.schema.json

Bounded one-shot or subscription read-next request.

Fields

Field Required Shape Description
schema yes const: sensorium-interface-read-request.v1 Contract discriminator.
schema/v yes const: 1 Contract version.
interface/id yes string Interface resource to read.
delivery/kind yes enum: one-shot, subscription Selects direct read or caller-bound leased read-next semantics.
subscription/id no string Required caller-bound lease for subscription delivery.
cursor/after no string Opaque interface- and source-generation-bound progress token.
batch yes ref: #/$defs/BatchLimits Caller-requested bounds narrowed by descriptor and host ceilings.
deadline/at yes string Absolute deadline by which admission and bounded observation must complete.
causal/context yes ref: causal-context.v1.schema.json P081 context for traceability; never authority.

Definitions

Definition Shape Description
BatchLimits object Independent frame-count, byte, and wait ceilings for one batch.

Conditional Rules

Rule 1

When:

{
  "properties": {
    "delivery/kind": {
      "const": "subscription"
    }
  },
  "required": [
    "delivery/kind"
  ]
}

Then:

{
  "required": [
    "subscription/id"
  ]
}

Field Semantics

schema

  • Required: yes
  • Shape: const: sensorium-interface-read-request.v1

Contract discriminator.

schema/v

  • Required: yes
  • Shape: const: 1

Contract version.

interface/id

  • Required: yes
  • Shape: string

Interface resource to read.

delivery/kind

  • Required: yes
  • Shape: enum: one-shot, subscription

Selects direct read or caller-bound leased read-next semantics.

subscription/id

  • Required: no
  • Shape: string

Required caller-bound lease for subscription delivery.

cursor/after

  • Required: no
  • Shape: string

Opaque interface- and source-generation-bound progress token.

batch

  • Required: yes
  • Shape: ref: #/$defs/BatchLimits

Caller-requested bounds narrowed by descriptor and host ceilings.

deadline/at

  • Required: yes
  • Shape: string

Absolute deadline by which admission and bounded observation must complete.

causal/context

  • Required: yes
  • Shape: ref: causal-context.v1.schema.json

P081 context for traceability; never authority.

Definition Semantics

$defs.BatchLimits

  • Shape: object

Independent frame-count, byte, and wait ceilings for one batch.