JSON contracts
One versioned system schema
insonic uses JSON Schema Draft 2020-12 for configuration, import, artifact/metadata interchange, portable catalog snapshots, durable job events, graph queries and speaker-training/model manifests. A system-wide master schema contains a registry of all insonic-owned contracts and selects documents through their kind. Shared definitions provide consistent identifiers, digests, revisions and artifact references. Cueson retains its own immutable upstream subtitle schema; the master recording embeds its validated current document without redefining that format. Its UUID assignments appear only there; external speaker mappings and other contracts carry current document/cue references, without another assignment list. Local packaged upstream schema bytes provide offline validation.
The master and child schemas live in schemas/v<version>/. Every release has the same software, documentation and master-schema version. A document declares schema_version and kind; the registry resolves its exact child contract. Tagged canonical schema IDs identify release resources, and the packaged registry resolves them offline. Schema files carry descriptions and examples for fields and complete documents. The documentation build reads those fields to produce the contract reference below and packages the JSON files beside it.
Compatibility and evolution
Portable workspace backups use the registered workspace-backup contract. Its manifest binds a consistent logical catalog proof to exact current/durable artifact publications, verified copied bytes or explicit original-store dependency, and accepted-evidence graph rebuilding. Structural validation does not substitute for byte hashes, source receipt validation, destination ownership checks or retention lifetime. See backup commands.
Release candidates use the registered release-candidate contract. The manifest records all six native platform/variant packages, corresponding-source and signing dispositions, exact source revision and documentation archives. Release tooling verifies the embedded package inventories, byte hashes and source identity before publication. See release preparation.
Model selection separates revisioned convenience aliases and configured source catalogs from immutable elected identities. Runtime requests expose alias/source CRUD, discovery and resolution; processing/import payloads freeze selected bundle manifests and acquisition dependencies. Optional compatibility metadata augments base manifests without rewriting accepted older digests. Portable catalog records retain alias/source revisions and trained/hosted target distinctions. Structural schema validation complements runtime checks for target ownership, complete bundle compatibility and job fences. See models for executable commands and lifecycle.
Recording replacement is a targeted media election with explicit transcript keep, clear or replace and declared-roster retain or clear policies. Keep requires an applicability assertion and validates known source-clock bounds and selected track/channel compatibility. A retained older managed subtitle can become the validated embedded current document during that same acceptance. Failure preserves previous accepted state. Roster read and edit requests carry independent optimistic revision authority; intentional membership remains distinct from document attribution and training evidence. The runtime request and import rules expose these elections consistently.
Preserve backward and forward compatibility where practical. Prefer additive optional fields, stable meanings, explicit extension containers and migrations over silently changing existing values. Readers validate against the document's declared version and negotiate adapter capabilities. An unknown version is reported clearly; it is not silently interpreted with whichever schema is newest. Keep supported older registries available for imports and migrations. Unsupported features can remain preserved as opaque extension values where the contract permits them.
Compatibility is a priority, not an absolute prohibition on useful change. When a change breaks a consumer or persisted contract, describe the affected fields, supported source versions and migration/recovery path in the changelog and the brief release highlights. Release notes retain the final changelog link. A schema revision alone does not prove compatibility; validation and representative import/export/migration fixtures establish the supported combinations.
Validation and documentation
Speaker-work requests distinguish dataset creation/inspection, elected training, exact speaker-version retrieval, profile CAS updates and matching-only work. Public matching input cannot supply server-frozen recording/model digests or replace the declared roster with a cluster-count hint. Zero score thresholds and ambiguity margins are explicit values. Catalog schema 9 carries portable output/profile/checkpoint authority and origin-qualified mappings; model/dataset manifests validate against their exact child contracts.
The repository checks master registration, matching release identities, schema validity, field descriptions and embedded examples. Every document example must validate both against its child schema and the master. Contract checks also reject malformed identities, contradictory inputs and mismatched kinds/versions. Structural validation is complemented by application checks for source ownership, time bounds, permissions, revision ordering and backend capabilities; JSON Schema cannot prove those relationships by itself.
The generated reference is read-only output. Edit descriptions, examples and field constraints in the authoritative JSON files, then rebuild documentation. The same packaged definitions serve CLI validation, adapter interchange and offline help. Catalog relationships, import behavior and speaker model lineage explain the domain rules around these payloads.
Contract reference
The versioned root of all insonic-owned interchange contracts. Each document identifies its kind and system schema version. Software, documentation and this registry share the same release version. Stable required fields define each operation while documented extension containers support adapter-specific values. Cueson documents retain their separate immutable upstream schema rather than being rewritten as an insonic format.
Download the master schema · Download shared definitions
The following definitions, descriptions and examples are generated from the versioned JSON Schema files during the documentation build.
insonic immutable artifact manifest
Portable inventory of complete immutable bytes. Hosted model handles without downloadable bytes belong in the speaker-model contract and are not invented digest entries here.
Download artifact-manifest.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of the insonic document contract. | |
kind |
Yes | Constant "artifact-manifest" | Document discriminator used by the master registry. | |
manifest_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable manifest identity. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace scope of all artifacts in this inventory. | |
created_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | Creation audit instant, unrelated to recording origination. | |
catalog_revision |
No | Reference: common.schema.json#/$defs/revision | Catalog revision represented by this inventory when captured. | |
artifacts |
Yes | array | Complete artifact entries. Application validation additionally rejects repeated artifact IDs with conflicting content identity. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced additions preserved without changing the core contract. |
artifacts
Complete artifact entries. Application validation additionally rejects repeated artifact IDs with conflicting content identity.
Value: array.
artifacts[]
One complete immutable artifact with portable byte identity and optional verified durable replicas.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable artifact identity across moves and materializations. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | SHA-256 of the full admitted bytes. | |
byte_length |
Yes | integer | Length of the complete immutable bytes. | |
artifact_kind |
Yes | "original-media", "supplied-subtitle", "metadata-report", "metadata-payload", "derived-audio", "transcript", "correlation", "training-manifest", "training-input", "training-checkpoint", "speaker-model", "query-result", "export", "other" | Declared lifecycle role, separate from MIME type and model capabilities. | |
media_type |
Yes | string | Declared content type for this artifact. Incoming MIME observations and resolver disagreements remain in metadata records. | |
retention_class |
Yes | "durable", "regenerable", "export" | Retention category. Referenced durable evidence is not disposable scratch. | |
locations |
No | array | Verified durable locations when available. Availability and leases are runtime state, separate from content identity. | |
producer_run_id |
No | Reference: common.schema.json#/$defs/uuid | Producing processing/training run when this is derived output. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional nonsecret artifact annotations. |
artifacts[].locations
Verified durable locations when available. Availability and leases are runtime state, separate from content identity.
Value: array.
artifacts[].locations[]
Durable managed object location. Keys identify exact objects; credentials and cached materialization paths never appear here.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
profile |
Yes | Reference: common.schema.json#/$defs/backendProfileReference | Profile selected to read this object. | |
storage_type |
Yes | "filesystem", "s3" | Official storage API used for the durable location. | |
key |
Yes | string | Managed relative filesystem key or immutable object key; no traversal or absolute path. | |
bucket |
No | string | S3 bucket containing the object; omitted for filesystem storage. | "media-library" |
version_id |
No | string | Provider object version identifier where supported; not a content digest. | "version-1" |
publication_receipt_id |
No | Reference: common.schema.json#/$defs/uuid | Receipt proving publication and verification before catalog admission. |
All of the following constraints apply:
When storage_type is "s3":
Value: object.
Required fields: bucket.
Otherwise:
Disallowed combination: has bucket.
Example
{
"schema_version": "1.0.0",
"kind": "artifact-manifest",
"manifest_id": "44444444-4444-4444-8444-444444444444",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"created_at": {
"iso": "2026-10-04T18:30:00Z",
"unix_ns": 1791138600000000000
},
"artifacts": [
{
"artifact_id": "22222222-2222-4222-8222-222222222222",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"byte_length": 4096,
"artifact_kind": "metadata-report",
"media_type": "application/json",
"retention_class": "durable",
"locations": [
{
"profile": {
"profile_id": "33333333-3333-4333-8333-333333333333",
"profile_revision": 1,
"adapter_id": "filesystem"
},
"storage_type": "filesystem",
"key": "objects/sha256/01/0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}
]
}
]
}
insonic downloaded base model manifest
Exact downloaded model identity, upstream revision, declared capabilities/license and ordered file digests. Registration does not claim local availability. Acquisition verifies every declared file before an available installation is committed. Credentials remain opaque references and never appear in URLs.
Download base-model-manifest.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "base-model-manifest" | Downloaded-model document discriminator, separate from speaker-trained models. | |
schema_version |
Yes | Constant "1.0.0" | Insonic contract release version. | |
name |
Yes | string | Exact upstream model family/name. | |
model_version |
Yes | string | Exact selected upstream model version, rather than an unpinned latest alias. | |
upstream_revision |
Yes | string | Immutable upstream revision associated with this manifest. | |
capabilities |
Yes | array | Declared adapter capabilities for later selection; registration does not run inference. | |
license |
Yes | string | Upstream license declaration retained with the selected model. | |
files |
Yes | array | Ordered required file roles and independently verified byte identities. The application rejects duplicate roles. | |
compatibility |
No | Reference: common.schema.json#/$defs/modelCompatibility | Optional adapter/runtime/audio compatibility retained in the immutable manifest digest. |
capabilities
Declared adapter capabilities for later selection; registration does not run inference.
Value: array.
capabilities[]
Declared capability name.
Value: string.
files
Ordered required file roles and independently verified byte identities. The application rejects duplicate roles.
Value: array.
files[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
role |
Yes | string | Unique role of this required model file. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of complete downloaded bytes. | |
size |
Yes | integer | Expected complete byte length, preserving known zero. | |
url |
Yes | string | Stable HTTPS source without user information, authentication query values or fragments. Explicit local_http permits HTTP only for a loopback model service; redirects must satisfy the same route rules. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Optional workspace-scoped credential reference resolved privately by the selected adapter. | |
local_http |
No | boolean | Explicit selection of unencrypted HTTP for localhost or a loopback IP only. |
Example
{
"kind": "base-model-manifest",
"schema_version": "1.0.0",
"name": "example-recognizer",
"model_version": "1.0.0",
"upstream_revision": "immutable-revision-1",
"capabilities": [
"recognition"
],
"license": "Apache-2.0",
"files": [
{
"role": "weights",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"size": 1048576,
"url": "https://models.example.org/recognizer/1.0.0/weights.bin"
}
]
}
Portable catalog snapshot
Consistent logical catalog export with typed provenance and ordered operational rows. Restoration verifies digest, workspace, supported migration version and all relationships, admits only an empty destination and expires imported authority. It does not copy artifact bytes or activate a different profile.
Download catalog-snapshot.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
catalog_schema |
Yes | 1, 2, 3, 4, 5, 6, 7, 8, 9 | Portable migration schema version supported by this catalog. | |
digest |
Yes | Reference: common.schema.json#/$defs/sha256 | SHA-256 of losslessly canonicalized snapshot with digest set to an empty string; checked during restoration. | |
kind |
Yes | Constant "catalog-snapshot" | Master-registry document discriminator. | |
records |
Yes | object | Typed Records record with scoped associations. | |
revision |
Yes | integer | Accepted workspace revision in the same consistent export transaction. | |
schema_version |
Yes | Constant "1.0.0" | Shared software/documentation/contract release version. | |
state |
Yes | array | Operational tables in dependency order; includes receipts, selections, jobs, attempts, leases, targets and events. Schema 1 has seven tables; schema 2 adds the typed artifact publication/lifecycle journal. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. |
records
Typed Records record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifacts |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
assets |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
datasets |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
date_selections |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
dates |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
locations |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
media |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
media_assets |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
members |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
metadata |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
model_artifacts |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
model_associations |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
models |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
observations |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
profiles |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
runs |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
segments |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
speakers |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
versions |
Yes | array or null | Deterministically ordered typed records, or null when empty. | |
library |
No | array or null | Current typed records, or null when empty. | |
works |
No | array or null | Current typed records, or null when empty. | |
cleanups |
No | array or null | Current typed records, or null when empty. | |
base_models |
No | array or null | Current typed records, or null when empty. | |
recordings |
No | array or null | Current authority rows, never alternate derived results. | |
speaker_mappings |
No | array or null | Current authority rows, never alternate derived results. | |
speaker_aliases |
No | array or null | Current typed records, ordered by stable identity; null or omission denotes an empty domain. | |
terms |
No | array or null | Current typed records, ordered by stable identity; null or omission denotes an empty domain. | |
pipelines |
No | array or null | Current typed records, ordered by stable identity; null or omission denotes an empty domain. | |
extractions |
No | array | Portable typed extractions, validated against accepted current-state proofs. | |
saved_queries |
No | array | Portable typed saved queries, validated against accepted current-state proofs. | |
graph_layouts |
No | array | Portable typed graph layouts, validated against accepted current-state proofs. | |
rosters |
No | array | Current intentional roster headers, independent of transcripts. | |
roster_members |
No | array | Unique references to existing centralized speaker identities. | |
model_aliases |
No | array or null | Deterministically ordered alias/source records including revision tombstones. | |
model_sources |
No | array or null | Deterministically ordered alias/source records including revision tombstones. | |
speaker_outputs |
No | array or null | Completed exact outputs preserved when current corpus is invalidated. | |
speaker_profiles |
No | array or null | Explicit exact version selections for roster matching. | |
speaker_checkpoints |
No | array or null | Validated resumable state distinct from completed models. |
records.artifacts
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.artifacts[]
Typed Artifact record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
digest |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
kind |
Yes | string | Typed text value retained without reinterpretation. | |
size |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. |
records.assets
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.assets[]
Typed Asset record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
duration_us |
Yes | integer | Legacy numeric source duration retained for existing catalog compatibility. When a current library record exists, its nullable duration_us is authoritative and an unknown value must not fall back to this legacy number. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
role |
Yes | string | Typed text value retained without reinterpretation. |
records.datasets
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.datasets[]
Typed Dataset record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
manifest_artifact_id |
Yes | At least one alternative | Derived artifact reference, or null after evidence invalidation. | |
options |
Yes | Structured value | Lossless structured report/options value; credentials remain references. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
state |
Yes | "current", "invalidated" | Whether current evidence authorizes this lineage. | |
invalidated_revision |
Yes | integer | Accepted evidence invalidation revision, or zero for current lineage. | |
invalidated_by |
Yes | At least one alternative | Current invalidation owner, or null for current lineage. |
records.datasets[].manifest_artifact_id
Derived artifact reference, or null after evidence invalidation.
At least one of the following alternatives must match:
records.datasets[].manifest_artifact_id: Alternative 1
Current managed derived artifact identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.datasets[].manifest_artifact_id: Alternative 2
Value: null.
records.datasets[].invalidated_by
Current invalidation owner, or null for current lineage.
At least one of the following alternatives must match:
records.datasets[].invalidated_by: Alternative 1
Recording or workspace responsible for accepted invalidation.
Value: Reference: common.schema.json#/$defs/uuid.
records.datasets[].invalidated_by: Alternative 2
Value: null.
All of the following constraints apply:
When state is "invalidated":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest_artifact_id |
No | null | Derived artifact reference is cleared when its evidence is invalidated. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest_artifact_id |
No | Reference: common.schema.json#/$defs/uuid | Derived artifact reference is cleared when its evidence is invalidated. |
records.date_selections
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.date_selections[]
Typed DateSelection record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
date_id |
Yes | At least one alternative | Workspace-scoped stable identity; relational provenance is validated by the adapter. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
media_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
policy |
Yes | string | Typed text value retained without reinterpretation. | |
reason |
Yes | string | Typed text value retained without reinterpretation. | |
revision |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. |
records.date_selections[].date_id
Workspace-scoped stable identity; relational provenance is validated by the adapter.
At least one of the following alternatives must match:
records.date_selections[].date_id: Alternative 1
Value: Reference: common.schema.json#/$defs/uuid.
records.date_selections[].date_id: Alternative 2
Value: null.
records.dates
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.dates[]
Typed DateObservation record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
basis |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
literal |
Yes | string | Typed text value retained without reinterpretation. | |
media_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
observation_id |
Yes | At least one alternative | Workspace-scoped stable identity; relational provenance is validated by the adapter. | |
offset_seconds |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
precision |
Yes | string | Typed text value retained without reinterpretation. | |
resolved |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
rules_version |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
zone |
Yes | At least one alternative | Typed catalog value, or null when unknown. |
records.dates[].observation_id
Workspace-scoped stable identity; relational provenance is validated by the adapter.
At least one of the following alternatives must match:
records.dates[].observation_id: Alternative 1
Value: Reference: common.schema.json#/$defs/uuid.
records.dates[].observation_id: Alternative 2
Value: null.
records.dates[].offset_seconds
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.dates[].offset_seconds: Alternative 1
Exact signed integer value; adapter enforces the logical field range.
Value: integer.
records.dates[].offset_seconds: Alternative 2
Value: null.
records.dates[].resolved
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.dates[].resolved: Alternative 1
Exact ISO/Unix-nanosecond audit instant; adapter checks agreement.
Value: Reference: common.schema.json#/$defs/utcInstant.
records.dates[].resolved: Alternative 2
Value: null.
records.dates[].rules_version
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.dates[].rules_version: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.dates[].rules_version: Alternative 2
Value: null.
records.dates[].zone
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.dates[].zone: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.dates[].zone: Alternative 2
Value: null.
records.locations
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.locations[]
Typed ArtifactLocation record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
key |
Yes | string | Typed text value retained without reinterpretation. | |
profile_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
profile_revision |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. | |
state |
Yes | string | Typed text value retained without reinterpretation. | |
version |
Yes | At least one alternative | Typed catalog value, or null when unknown. |
records.locations[].version
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.locations[].version: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.locations[].version: Alternative 2
Value: null.
records.media
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.media[]
Typed Media record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
class |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
title |
Yes | string | Typed text value retained without reinterpretation. |
records.media_assets
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.media_assets[]
Typed MediaAsset record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
asset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
media_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
role |
Yes | string | Typed text value retained without reinterpretation. |
records.members
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.members[]
Typed DatasetMember record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
dataset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
ordinal |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. | |
segment_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
segment_revision |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. |
records.metadata
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.metadata[]
Typed MetadataSnapshot record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
asset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
captured |
Yes | Reference: common.schema.json#/$defs/utcInstant | Exact ISO/Unix-nanosecond audit instant; adapter checks agreement. | |
extractor |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
report_artifact_id |
Yes | At least one alternative | Workspace-scoped stable identity; relational provenance is validated by the adapter. | |
state |
Yes | string | Typed text value retained without reinterpretation. | |
version |
Yes | string | Typed text value retained without reinterpretation. |
records.metadata[].report_artifact_id
Workspace-scoped stable identity; relational provenance is validated by the adapter.
At least one of the following alternatives must match:
records.metadata[].report_artifact_id: Alternative 1
Value: Reference: common.schema.json#/$defs/uuid.
records.metadata[].report_artifact_id: Alternative 2
Value: null.
records.model_artifacts
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.model_artifacts[]
Typed ModelArtifact record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
format |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
role |
Yes | string | Typed text value retained without reinterpretation. | |
version_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. |
records.model_associations
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.model_associations[]
Typed ModelAssociation record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
model_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
reason |
Yes | string | Typed text value retained without reinterpretation. | |
revision |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. |
records.models
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.models[]
Typed Model record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
name |
Yes | string | Typed text value retained without reinterpretation. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. |
records.observations
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.observations[]
Typed Observation record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
family |
Yes | string | Typed text value retained without reinterpretation. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
instance |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. | |
precision |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
raw |
Yes | Structured value | Lossless structured report/options value; credentials remain references. | |
snapshot_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
tag |
Yes | string | Typed text value retained without reinterpretation. | |
unit |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
value |
Yes | Structured value | Lossless structured report/options value; credentials remain references. |
records.observations[].precision
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.observations[].precision: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.observations[].precision: Alternative 2
Value: null.
records.observations[].unit
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.observations[].unit: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.observations[].unit: Alternative 2
Value: null.
records.profiles
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.profiles[]
Typed Profile record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | string | Typed text value retained without reinterpretation. | |
configuration |
Yes | Structured value | Lossless structured report/options value; credentials remain references. | |
credential_id |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
expected_backend_version |
Yes | At least one alternative | Typed catalog value, or null when unknown. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
revision |
Yes | integer | Exact signed integer value; adapter enforces the logical field range. | |
role |
Yes | string | Typed text value retained without reinterpretation. | |
version |
Yes | string | Typed text value retained without reinterpretation. |
records.profiles[].credential_id
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.profiles[].credential_id: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.profiles[].credential_id: Alternative 2
Value: null.
records.profiles[].expected_backend_version
Typed catalog value, or null when unknown.
At least one of the following alternatives must match:
records.profiles[].expected_backend_version: Alternative 1
Typed text value retained without reinterpretation.
Value: string.
records.profiles[].expected_backend_version: Alternative 2
Value: null.
records.runs
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.runs[]
Typed TrainingRun record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | string | Typed text value retained without reinterpretation. | |
dataset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
job_id |
Yes | Reference: common.schema.json#/$defs/uuid | Producing durable work identity; historical job identity remains accepted for earlier records. | |
options |
Yes | Structured value | Lossless structured report/options value; credentials remain references. | |
preparation_artifact_id |
Yes | At least one alternative | Derived artifact reference, or null after evidence invalidation. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
state |
Yes | "current", "invalidated" | Whether current evidence authorizes this lineage. |
records.runs[].preparation_artifact_id
Derived artifact reference, or null after evidence invalidation.
At least one of the following alternatives must match:
records.runs[].preparation_artifact_id: Alternative 1
Current managed derived artifact identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.runs[].preparation_artifact_id: Alternative 2
Value: null.
All of the following constraints apply:
When state is "invalidated":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
preparation_artifact_id |
No | null | Derived artifact reference is cleared when its evidence is invalidated. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
preparation_artifact_id |
No | Reference: common.schema.json#/$defs/uuid | Derived artifact reference is cleared when its evidence is invalidated. |
records.segments
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.segments[]
Reference to current embedded subtitle/speaker evidence. Timings, attribution payloads and known-person assignments are resolved from the current recording and mapping; they are not copied here.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable segment reference identity. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Immutable reference revision. | |
recording_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current recording owning the embedded Cueson evidence. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Exact current embedded document digest; stale references fail resolution. | |
cue_id |
Yes | string | Cue identity inside the current embedded document. | |
local_speaker_id |
Yes | Reference: common.schema.json#/$defs/localSpeakerID | Recording-scoped local speaker token occurring in this cue attribution. | |
clip_artifact_id |
Yes | At least one alternative | Optional derived clip identity, or null. A clip does not become assignment authority. |
records.segments[].clip_artifact_id
Optional derived clip identity, or null. A clip does not become assignment authority.
At least one of the following alternatives must match:
records.segments[].clip_artifact_id: Alternative 1
Optional managed prepared clip identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.segments[].clip_artifact_id: Alternative 2
Value: null.
records.speakers
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.speakers[]
Typed Speaker record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
name |
Yes | string | Typed text value retained without reinterpretation. | |
revision |
No | integer | Accepted aggregate revision used for compare-and-swap. | |
state |
No | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. |
records.versions
Deterministically ordered typed records, or null when empty.
Value: array or null.
records.versions[]
Typed ModelVersion record with scoped associations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
dataset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
kind |
Yes | string | Typed text value retained without reinterpretation. | |
manifest_artifact_id |
Yes | At least one alternative | Derived artifact reference, or null after evidence invalidation. | |
model_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
run_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped stable record identity. | |
state |
Yes | "current", "invalidated" | Whether current evidence authorizes this lineage. |
records.versions[].manifest_artifact_id
Derived artifact reference, or null after evidence invalidation.
At least one of the following alternatives must match:
records.versions[].manifest_artifact_id: Alternative 1
Current managed derived artifact identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.versions[].manifest_artifact_id: Alternative 2
Value: null.
All of the following constraints apply:
When state is "invalidated":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest_artifact_id |
No | null | Derived artifact reference is cleared when its evidence is invalidated. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest_artifact_id |
No | Reference: common.schema.json#/$defs/uuid | Derived artifact reference is cleared when its evidence is invalidated. |
records.library
Current typed records, or null when empty.
Value: array or null.
records.library[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
asset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
title |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
class |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
mode |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
source_locator |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
digest |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
size |
Yes | integer | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
original_publication_id |
Yes | At least one alternative | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
subtitle_publication_id |
Yes | At least one alternative | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
duration_us |
Yes | integer or null | Authoritative measured recording duration in integer microseconds. Null is unknown; zero is measured zero. Subtitle coverage never supplies this value. | |
facts |
Yes | Structured value | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
metadata |
Yes | Structured value | Only the current normalized capture, with complete extraction provenance and explicit coverage. Superseded derived payloads are removed. | |
dates |
Yes | Structured value | Current owner and source date observations, conflicts, interpretation state and selected precedence rule. Owner date evidence survives computed-capture replacement. | |
report_publication_ids |
Yes | array | Current raw metadata report publication identities. Replacements remove superseded references and queue physical retirement. | |
revision |
Yes | integer | Current typed catalog value; adapter enforces scoped identity and logical constraints. |
records.library[].original_publication_id
Current typed catalog value; adapter enforces scoped identity and logical constraints.
At least one of the following alternatives must match:
records.library[].original_publication_id: Alternative 1
Value: Reference: common.schema.json#/$defs/uuid.
records.library[].original_publication_id: Alternative 2
Value: null.
records.library[].subtitle_publication_id
Current typed catalog value; adapter enforces scoped identity and logical constraints.
At least one of the following alternatives must match:
records.library[].subtitle_publication_id: Alternative 1
Value: Reference: common.schema.json#/$defs/uuid.
records.library[].subtitle_publication_id: Alternative 2
Value: null.
records.library[].report_publication_ids
Current raw metadata report publication identities. Replacements remove superseded references and queue physical retirement.
Value: array.
records.library[].report_publication_ids[]
Workspace-scoped managed publication identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.works
Current typed records, or null when empty.
Value: array or null.
records.works[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
journal_receipt_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
kind |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
payload |
Yes | Structured value | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
state |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
owner |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
generation |
Yes | integer | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
lease_until |
Yes | integer | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
phase |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
result |
Yes | Structured value | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
error |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. |
records.cleanups
Current typed records, or null when empty.
Value: array or null.
records.cleanups[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
entry_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
state |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
revision |
Yes | integer | Accepted current-replacement revision whose receipt lists this publication for physical cleanup. Restore verifies that association before a worker can retire bytes. | |
legacy_location_id |
No | At least one alternative | Optional location-only migration obligation. Pending has no invented admission; completion requires actual retirement. |
records.cleanups[].legacy_location_id
Optional location-only migration obligation. Pending has no invented admission; completion requires actual retirement.
At least one of the following alternatives must match:
records.cleanups[].legacy_location_id: Alternative 1
Exact legacy location identity requiring selected-store verified adoption.
Value: Reference: common.schema.json#/$defs/uuid.
records.cleanups[].legacy_location_id: Alternative 2
Value: null.
records.base_models
Current typed records, or null when empty.
Value: array or null.
records.base_models[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
name |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
version |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
digest |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
manifest |
Yes | Reference: base-model-manifest.schema.json | Exact selected downloaded-model manifest, separate from speaker-trained model lineage. | |
publication_ids |
Yes | array | Ordered verified required model-file publication identities. | |
state |
Yes | string | Current typed catalog value; adapter enforces scoped identity and logical constraints. | |
revision |
Yes | integer | Current typed catalog value; adapter enforces scoped identity and logical constraints. |
records.base_models[].publication_ids
Ordered verified required model-file publication identities.
Value: array.
records.base_models[].publication_ids[]
Workspace-scoped managed publication identity.
Value: Reference: common.schema.json#/$defs/uuid.
records.recordings
Current authority rows, never alternate derived results.
Value: array or null.
records.recordings[]
Value: Reference: recording.schema.json#/$defs/current.
records.speaker_mappings
Current authority rows, never alternate derived results.
Value: array or null.
records.speaker_mappings[]
Value: Reference: recording.schema.json#/$defs/mapping.
records.speaker_aliases
Current typed records, ordered by stable identity; null or omission denotes an empty domain.
Value: array or null.
records.speaker_aliases[]
Current alias; updates are fenced by the owning speaker aggregate revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable alias identity. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Owning known-speaker identity. | |
text |
Yes | string | Explicit alias text. | |
language |
Yes | string | Language scope or empty for any selected language. | |
scope |
Yes | string | Context scope or empty for any selected context. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. | |
provenance |
Yes | object | Nonsecret reference-only origin metadata; credentials, transcript copies and attribution arrays are rejected by the catalog. |
records.terms
Current typed records, ordered by stable identity; null or omission denotes an empty domain.
Value: array or null.
records.terms[]
Current revisioned recognition term.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable vocabulary entry identity. | |
revision |
Yes | integer | Accepted term revision used for compare-and-swap. | |
canonical |
Yes | string | Canonical recognition hint. | |
variants |
Yes | array | Ordered variants, deduplicated only during context compilation. | |
language |
Yes | string | Language scope or empty for any selected language. | |
context |
Yes | string | Context scope or empty for any selected context. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. | |
speaker_id |
Yes | At least one alternative | Optional known-speaker link. | |
alias_id |
Yes | At least one alternative | Optional alias link. | |
provenance |
Yes | object | Nonsecret reference-only origin metadata; credentials, transcript copies and attribution arrays are rejected by the catalog. |
records.terms[].variants
Ordered variants, deduplicated only during context compilation.
Value: array.
records.terms[].variants[]
Explicit recognition variant.
Value: string.
records.terms[].speaker_id
Optional known-speaker link.
At least one of the following alternatives must match:
records.terms[].speaker_id: Alternative 1
Optional known-speaker link.
Value: Reference: common.schema.json#/$defs/uuid.
records.terms[].speaker_id: Alternative 2
Value: null.
records.terms[].alias_id
Optional alias link.
At least one of the following alternatives must match:
records.terms[].alias_id: Alternative 1
Optional alias link; must belong to the linked speaker when both are supplied.
Value: Reference: common.schema.json#/$defs/uuid.
records.terms[].alias_id: Alternative 2
Value: null.
records.pipelines
Current typed records, ordered by stable identity; null or omission denotes an empty domain.
Value: array or null.
records.pipelines[]
Current saved pipeline definition; work captures its effective revision separately.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable saved pipeline identity. | |
name |
Yes | string | Readable pipeline name. | |
preset |
Yes | "local", "connected", "custom" | Canonical preset; stage election validates its explicit routing. | |
revision |
Yes | integer | Accepted pipeline revision used for compare-and-swap. | |
configuration |
Yes | Reference: pipeline-config.schema.json#/$defs/configuration | Effective stage defaults with credential references only. |
records.extractions
Portable typed extractions, validated against accepted current-state proofs.
Value: array.
records.extractions[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | id in the current exploration contract. | |
revision |
Yes | integer | revision in the current exploration contract. | |
recording_revision |
Yes | integer | recording revision in the current exploration contract. | |
document_digest |
Yes | string | document digest in the current exploration contract. | |
assertions |
Yes | array | assertions in the current exploration contract. | |
provenance |
Yes | object | provenance in the current exploration contract. | |
diagnostics |
Yes | array | diagnostics in the current exploration contract. |
records.saved_queries
Portable typed saved queries, validated against accepted current-state proofs.
Value: array.
records.saved_queries[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | id in the current exploration contract. | |
revision |
Yes | integer | revision in the current exploration contract. | |
definition |
Yes | object | definition in the current exploration contract. | |
validations |
Yes | array | Immutable backend compatibility findings for this saved version. |
records.saved_queries[].validations
Immutable backend compatibility findings for this saved version.
Value: array.
records.saved_queries[].validations[]
Compatibility check result.
Value: object.
records.graph_layouts
Portable typed graph layouts, validated against accepted current-state proofs.
Value: array.
records.graph_layouts[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | id in the current exploration contract. | |
query_id |
Yes | Reference: common.schema.json#/$defs/uuid | query id in the current exploration contract. | |
revision |
Yes | integer | revision in the current exploration contract. | |
layout |
Yes | object | layout in the current exploration contract. |
records.rosters
Current intentional roster headers, independent of transcripts.
Value: array.
records.rosters[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | string | Stable workspace-scoped UUID. | |
revision |
Yes | integer | Positive accepted current roster revision. |
records.roster_members
Unique references to existing centralized speaker identities.
Value: array.
records.roster_members[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | string | Stable workspace-scoped UUID. | |
recording_id |
Yes | string | Stable parent recording UUID. | |
speaker_id |
Yes | string | Existing centralized speaker UUID. | |
revision |
Yes | integer | Positive accepted current roster revision. |
records.model_aliases
Deterministically ordered alias/source records including revision tombstones.
Value: array or null.
records.model_aliases[]
Typed workspace-scoped portable record.
Value: Reference: common.schema.json#/$defs/modelAlias.
records.model_sources
Deterministically ordered alias/source records including revision tombstones.
Value: array or null.
records.model_sources[]
Typed workspace-scoped portable record.
Value: Reference: common.schema.json#/$defs/modelSource.
records.speaker_outputs
Completed exact outputs preserved when current corpus is invalidated.
Value: array or null.
records.speaker_outputs[]
Immutable speaker output, independent of current preparation validity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact workspace-scoped id. | |
model_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact workspace-scoped model id. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact workspace-scoped speaker id. | |
dataset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact workspace-scoped dataset id. | |
work_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact workspace-scoped work id. | |
kind |
Yes | string | Declared immutable output kind. | |
name |
Yes | string | Speaker model name. | |
metadata |
Yes | Reference: speaker-model.schema.json | Immutable noncontent output identity, compatibility and origin manifest. | |
publication_ids |
Yes | array | Available durable output publications. |
records.speaker_outputs[].publication_ids
Available durable output publications.
Value: array.
records.speaker_outputs[].publication_ids[]
Exact verified artifact publication.
Value: Reference: common.schema.json#/$defs/uuid.
All of the following constraints apply:
When metadata matches object:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
publication_ids |
No | array | Current outputs include the accepted model manifest publication. |
records.speaker_profiles
Explicit exact version selections for roster matching.
Value: array or null.
records.speaker_profiles[]
Revisioned current speaker profile head.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Centralized speaker identity owning the current profile. | |
revision |
Yes | integer | Positive revision fencing profile changes. | |
version_id |
Yes | string | Exact selected output version, empty only when cleared. | |
state |
Yes | "active", "cleared" | Current profile election state. |
All of the following constraints apply:
When state matches "active":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
version_id |
No | Reference: common.schema.json#/$defs/uuid | Exact selected immutable output version. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
version_id |
No | Constant "" | Cleared profile retains no selected version. |
records.speaker_checkpoints
Validated resumable state distinct from completed models.
Value: array or null.
records.speaker_checkpoints[]
Immutable producing-attempt checkpoint.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Immutable checkpoint identity. | |
work_id |
Yes | Reference: common.schema.json#/$defs/uuid | Producing durable work identity. | |
attempt |
Yes | integer | Producing work attempt generation. | |
step |
Yes | integer | Declared training step. | |
base_digest |
Yes | string | Exact base digest, empty only for base-independent output. | |
compatibility |
Yes | string | Declared resume compatibility identity. | |
adapter_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Exact producing adapter declaration digest. | |
publication_id |
Yes | Reference: common.schema.json#/$defs/uuid | Verified checkpoint publication. |
state
Operational tables in dependency order; includes receipts, selections, jobs, attempts, leases, targets and events. Schema 1 has seven tables; schema 2 adds the typed artifact publication/lifecycle journal.
Value: array.
state[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
name |
Yes | "operation_receipt", "setting_revision", "job", "job_attempt", "workspace_lease", "graph_target", "graph_event", "artifact_publication" | Fixed operational table identity; SQL identifiers are never supplied by the caller. | |
rows |
Yes | array | Ordered complete rows in the table's portable layout; restoration validates width, types and semantic relationships. |
state[].rows
Ordered complete rows in the table's portable layout; restoration validates width, types and semantic relationships.
Value: array.
state[].rows[]
Operational row cells in the fixed table column order. JSON reports/results are stored as strings; integer cells remain exact.
Value: array.
state[].rows[][]
At least one of the following alternatives must match:
state[].rows[][]: Alternative 1
Value: string.
state[].rows[][]: Alternative 2
Value: integer.
state[].rows[][]: Alternative 3
Value: null.
All of the following constraints apply:
When catalog_schema is 5:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
records |
No | object | Current records contract. |
records
Current records contract.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speakers |
No | array or null | Current speakers contract. |
records.speakers
Current speakers contract.
Value: array or null.
records.speakers[]
Current known-speaker identity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Known-speaker identity, independent of recording-local voice IDs. | |
name |
Yes | string | Canonical display name; equal names never merge people. | |
revision |
Yes | integer | Accepted aggregate revision used for compare-and-swap. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. |
Definition: speaker
Current known-speaker identity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Known-speaker identity, independent of recording-local voice IDs. | |
name |
Yes | string | Canonical display name; equal names never merge people. | |
revision |
Yes | integer | Accepted aggregate revision used for compare-and-swap. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. |
Definition: speakerAlias
Current alias; updates are fenced by the owning speaker aggregate revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable alias identity. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Owning known-speaker identity. | |
text |
Yes | string | Explicit alias text. | |
language |
Yes | string | Language scope or empty for any selected language. | |
scope |
Yes | string | Context scope or empty for any selected context. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. | |
provenance |
Yes | object | Nonsecret reference-only origin metadata; credentials, transcript copies and attribution arrays are rejected by the catalog. |
Definition: term
Current revisioned recognition term.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable vocabulary entry identity. | |
revision |
Yes | integer | Accepted term revision used for compare-and-swap. | |
canonical |
Yes | string | Canonical recognition hint. | |
variants |
Yes | array | Ordered variants, deduplicated only during context compilation. | |
language |
Yes | string | Language scope or empty for any selected language. | |
context |
Yes | string | Context scope or empty for any selected context. | |
state |
Yes | "active", "inactive" | Explicit context eligibility; deactivation preserves stable identity and links. | |
speaker_id |
Yes | At least one alternative | Optional known-speaker link. | |
alias_id |
Yes | At least one alternative | Optional alias link. | |
provenance |
Yes | object | Nonsecret reference-only origin metadata; credentials, transcript copies and attribution arrays are rejected by the catalog. |
Definition: term.variants
Ordered variants, deduplicated only during context compilation.
Value: array.
Definition: term.variants[]
Explicit recognition variant.
Value: string.
Definition: term.speaker_id
Optional known-speaker link.
At least one of the following alternatives must match:
Definition: term.speaker_id: Alternative 1
Optional known-speaker link.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: term.speaker_id: Alternative 2
Value: null.
Definition: term.alias_id
Optional alias link.
At least one of the following alternatives must match:
Definition: term.alias_id: Alternative 1
Optional alias link; must belong to the linked speaker when both are supplied.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: term.alias_id: Alternative 2
Value: null.
Definition: pipeline
Current saved pipeline definition; work captures its effective revision separately.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable saved pipeline identity. | |
name |
Yes | string | Readable pipeline name. | |
preset |
Yes | "local", "connected", "custom" | Canonical preset; stage election validates its explicit routing. | |
revision |
Yes | integer | Accepted pipeline revision used for compare-and-swap. | |
configuration |
Yes | Reference: pipeline-config.schema.json#/$defs/configuration | Effective stage defaults with credential references only. |
Example
{
"kind": "catalog-snapshot",
"schema_version": "1.0.0",
"catalog_schema": 1,
"workspace_id": "10000000-0000-4000-8000-000000000001",
"revision": 0,
"records": {
"profiles": null,
"artifacts": null,
"locations": null,
"media": null,
"assets": null,
"media_assets": null,
"metadata": null,
"observations": null,
"dates": null,
"date_selections": null,
"speakers": null,
"segments": null,
"datasets": null,
"members": null,
"runs": null,
"models": null,
"versions": null,
"model_artifacts": null,
"model_associations": null,
"library": null,
"works": null,
"cleanups": null,
"base_models": null
},
"state": [
{
"name": "operation_receipt",
"rows": []
},
{
"name": "setting_revision",
"rows": []
},
{
"name": "job",
"rows": []
},
{
"name": "job_attempt",
"rows": []
},
{
"name": "workspace_lease",
"rows": []
},
{
"name": "graph_target",
"rows": []
},
{
"name": "graph_event",
"rows": []
}
],
"digest": "17c5708b98f6e943d890677b193f530dcc759356a9501269ed7a3443f0919d1f"
}
insonic saved graph query
Immutable query definitions with typed parameters and declared backend compatibility. Every execution resolves current sources; presentation state is separate from evidence.
Download graph-query.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this insonic document contract. | |
kind |
Yes | Constant "graph-query" | Document discriminator registered by the master schema. | |
query_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable query identity across edited revisions. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Immutable saved query revision. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace containing its referenced entities. | |
title |
Yes | string | Human-readable saved query title. | |
access_mode |
Yes | "read-only" | Ordinary exploration is read-only; maintenance is a separately explicit application operation. | |
definition |
Yes | Exactly one alternative | Exactly one normalized application specification or native dialect/text definition. | |
parameters |
Yes | object | Named typed parameters, passed as values rather than interpolated query text. | |
page |
No | object | Bounded result pagination with explicit truncation/cursor reporting. | |
validations |
Yes | array | Compatibility checks for selected backend versions. No entry means compatibility has not been established. | |
view |
No | object | Presentation defaults only. Runtime graph positions are stored separately; saved definitions never retain result snapshots. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced extension data without changing event/query authority. |
definition
Exactly one normalized application specification or native dialect/text definition.
Exactly one of the following alternatives must match:
definition: normalized
Portable application QuerySpec compiled separately by each official graph adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
Yes | Constant "normalized" | Selects backend-neutral application operations. | |
operation |
Yes | "media-list", "speaker-search", "model-list", "text-search", "time-range", "evidence-traverse", "graph-view" | Supported normalized operation with identical intended results on LadybugDB and ArcadeDB. | |
filters |
No | object | Portable application filters. Unknown filters are rejected instead of ignored. | |
traversal |
No | object | Explicit bounded graph expansion, without an engine-specific query string. | |
order_by |
No | array | Deterministic ordering, with a stable entity-ID tie breaker added by the application if needed. | |
pagination |
No | object | Bounded current-result pagination. |
definition: normalized.filters
Portable application filters. Unknown filters are rejected instead of ignored.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
media_ids |
No | array | Restrict to explicit media entries. | |
speaker_ids |
No | array | Current speaker/lineage filter. | |
text |
No | string | Text/term search phrase, interpreted by the selected normalized operation. | |
model_kind |
No | string | Declared trained-model kind filter. | |
recording_dates |
No | object | Origination calendar filter preserving timezone and undated handling. | |
source_interval |
No | Reference: common.schema.json#/$defs/mediaInterval | Original-clock interval filter; application checks source ownership and bounds. | |
concept_ids |
No | array | Concept filter for evidence/graph traversal. | |
entity_ids |
No | array | Stable projected graph node references used as bounded traversal seeds. |
definition: normalized.filters.media_ids
Restrict to explicit media entries.
Value: array.
definition: normalized.filters.media_ids[]
Selected library media entry ID.
Value: Reference: common.schema.json#/$defs/uuid.
definition: normalized.filters.speaker_ids
Current speaker/lineage filter.
Value: array.
definition: normalized.filters.speaker_ids[]
Selected catalog speaker ID.
Value: Reference: common.schema.json#/$defs/uuid.
definition: normalized.filters.recording_dates
Origination calendar filter preserving timezone and undated handling.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
from |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive first recording date. | |
through |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive last recording date. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Calendar timezone for this filter. | |
include_undated |
No | boolean | Explicitly include entries with unknown recording dates. |
definition: normalized.filters.concept_ids
Concept filter for evidence/graph traversal.
Value: array.
definition: normalized.filters.concept_ids[]
Normalized concept ID.
Value: Reference: common.schema.json#/$defs/uuid.
definition: normalized.filters.entity_ids
Stable projected graph node references used as bounded traversal seeds.
Value: array.
definition: normalized.filters.entity_ids[]
Current projected graph node ID.
Value: string.
definition: normalized.traversal
Explicit bounded graph expansion, without an engine-specific query string.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
relationship_types |
No | array | Relationship types included in expansion. | |
direction |
Yes | "out", "in", "both" | Direction of selected relationships. | |
max_depth |
Yes | integer | Positive explicit traversal depth; application capacity policies remain visible. |
definition: normalized.traversal.relationship_types
Relationship types included in expansion.
Value: array.
definition: normalized.traversal.relationship_types[]
Logical relationship type from the versioned projection schema.
Value: string.
definition: normalized.order_by
Deterministic ordering, with a stable entity-ID tie breaker added by the application if needed.
Value: array.
definition: normalized.order_by[]
One ordered result field.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
field |
Yes | "id", "title", "recording_date", "source_start_us", "speaker_name", "relevance", "media.originated_at", "media.id", "speaker.id", "model.id", "cue.start_us", "score" | Normalized field available to the selected operation. | |
direction |
Yes | "asc", "desc" | Sort direction. |
definition: normalized.pagination
Bounded current-result pagination.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Maximum number of returned rows. | |
cursor |
No | string | Opaque current-result continuation cursor. |
definition: native
Advanced query text with a declared dialect; arbitrary native text is not automatically portable.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
Yes | Constant "native" | Selects a declared native query dialect. | |
dialect |
Yes | string | Official native dialect or explicitly namespaced unofficial community dialect. | |
text |
Yes | string | Native query text. Read-only or maintenance operation mode is enforced by the adapter and configured privileges. |
definition: native.dialect
Official native dialect or explicitly namespaced unofficial community dialect.
Value: string.
At least one of the following alternatives must match:
definition: native.dialect: Alternative 1
Value: "ladybug-cypher", "arcade-opencypher", "arcade-sql".
definition: native.dialect: Alternative 2
Value: string.
parameters
Named typed parameters, passed as values rather than interpolated query text.
Value: object.
parameters{name}
Typed native-query parameter normalized by the selected adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
type |
Yes | "string", "integer", "number", "boolean", "uuid", "date-time", "date", "array", "object", "null" | Logical parameter type, independent of backend value wrappers. | |
value |
Yes | At least one alternative | Parameter value matching its declared logical type; native adapters validate any narrower backend constraints. |
parameters{name}.value
Parameter value matching its declared logical type; native adapters validate any narrower backend constraints.
At least one of the following alternatives must match:
parameters{name}.value: Alternative 1
Value: string.
parameters{name}.value: Alternative 2
Value: number.
parameters{name}.value: Alternative 3
Value: boolean.
parameters{name}.value: Alternative 4
Value: null.
parameters{name}.value: Alternative 5
Value: array.
parameters{name}.value: Alternative 6
Value: object.
All of the following constraints apply:
When type is "string":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | string | Value with the declared string JSON type. |
When type is "integer":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Exactly one alternative | Exact signed 64-bit integer as a JSON integer or canonical decimal string; the runtime enforces range. |
value
Exact signed 64-bit integer as a JSON integer or canonical decimal string; the runtime enforces range.
Exactly one of the following alternatives must match:
value: Alternative 1
Value: integer.
value: Alternative 2
Value: string.
When type is "number":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | number | Value with the declared number JSON type. |
When type is "boolean":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | boolean | Value with the declared boolean JSON type. |
When type is "uuid":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/uuid | UUID parameter value. |
When type is "date-time":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/utcInstant | UTC instant parameter value. |
When type is "date":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/calendarDate | Date-only parameter value. |
When type is "array":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | array | Value with the declared array JSON type. |
When type is "object":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | object | Value with the declared object JSON type. |
When type is "null":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | null | Value with the declared null JSON type. |
page
Bounded result pagination with explicit truncation/cursor reporting.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Requested positive result count. | |
cursor |
No | string | Opaque continuation cursor bound to the query/revision and its validated parameters. |
validations
Compatibility checks for selected backend versions. No entry means compatibility has not been established.
Value: array.
validations[]
Recorded compatibility check for one backend/schema/capability target.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
target_profile |
Yes | Reference: common.schema.json#/$defs/backendProfileReference | Target graph backend profile. | |
adapter_id |
Yes | "ladybugdb", "arcadedb", "community" | Adapter that performed or awaits compatibility validation. | |
catalog_schema_version |
Yes | string | Catalog schema contract used by validation. | |
projection_schema_version |
Yes | string | Graph projection schema version used by validation. | |
status |
Yes | "validated", "incompatible", "pending" | Validation state; incompatible native text remains stored with diagnostics. | |
backend_version |
No | string | Exact engine/server version evaluated. | |
capability_fingerprint |
No | Reference: common.schema.json#/$defs/sha256 | Digest of the evaluated canonical capability contract. | |
validated_at |
No | Reference: common.schema.json#/$defs/utcInstant | Audit instant for the completed compatibility check. | |
diagnostics |
No | array | Reasons a saved query is incompatible or limited. |
validations[].diagnostics
Reasons a saved query is incompatible or limited.
Value: array.
validations[].diagnostics[]
Readable compatibility finding.
Value: string.
All of the following constraints apply:
When status is "validated":
Value: object.
Required fields: backend_version, capability_fingerprint, validated_at.
view
Presentation defaults only. Runtime graph positions are stored separately; saved definitions never retain result snapshots.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
layout |
Yes | "force-directed", "table" | Graph presentation and its accessible table alternative. | |
positions |
No | array | Saved display positions separate from node data. |
view.positions
Saved display positions separate from node data.
Value: array.
view.positions[]
Position of one stable catalog node ID.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
node_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable application graph entity ID. | |
x |
Yes | number | Horizontal layout coordinate. | |
y |
Yes | number | Vertical layout coordinate. |
Example
{
"schema_version": "1.0.0",
"kind": "graph-query",
"query_id": "dddddddd-dddd-4ddd-8ddd-dddddddddddd",
"revision": 1,
"workspace_id": "11111111-1111-4111-8111-111111111111",
"title": "Speaker evidence",
"access_mode": "read-only",
"definition": {
"mode": "normalized",
"operation": "evidence-traverse",
"filters": {
"speaker_ids": [
"eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee"
]
},
"traversal": {
"direction": "both",
"max_depth": 2
}
},
"parameters": {},
"page": {
"limit": 100
},
"validations": [],
"view": {
"layout": "force-directed",
"positions": []
}
}
insonic import manifest
Batch import input for the CLI and its GUI wrapper. Syntax validation precedes application validation of source access, calendar values, timezone/DST policy and admission. No approval per item is required for already configured routing.
Download import-manifest.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of the insonic document contract. | |
kind |
Yes | Constant "import-manifest" | Document discriminator used by the master registry. | |
defaults |
No | object | Recording-date defaults and policies. Exact timestamp, calendar date and approximate UTC range are mutually exclusive. | |
items |
Yes | array | Inputs in deterministic admission order, with independent partial-result reporting. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced additions preserved without changing the core contract. |
defaults
Recording-date defaults and policies. Exact timestamp, calendar date and approximate UTC range are mutually exclusive.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
originated_at |
No | Reference: common.schema.json#/$defs/wallTimestamp | Entered recording timestamp, distinct from import, publication and file modification times. | |
originated_on |
No | Reference: common.schema.json#/$defs/calendarDate | Entered recording date when the recording time is unknown. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Timezone for unzoned recording timestamps; local is resolved once for the batch. | |
dst_fold |
No | "earlier", "later" | Explicit choice of offset for an ambiguous repeated daylight-saving wall time. | |
dst_gap |
No | Constant "shift-forward" | Explicit policy to resolve a nonexistent wall time by shifting forward; absent means no silent correction. | |
copy |
No | boolean | True admits a managed copy into the selected artifact store; false keeps an explicitly tracked local reference. | |
preset |
No | string | Configured processing/import preset name or ID; does not embed provider configuration. | "local" |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional nonsecret input annotations. | |
date_precedence |
No | "owner-first", "embedded-first", "filesystem-fallback" | Versioned recording-date precedence rule. Filesystem modification becomes a recording-date candidate only under the explicit filesystem-fallback rule. | |
originated_earliest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive earliest recording instant for an owner-supplied approximate date range. Preserve the exact UTC timestamp and integer clock. | |
originated_latest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive latest recording instant for an owner-supplied approximate date range. Application validation checks bound ordering. | |
local_http |
No | boolean | Explicitly elect HTTP credential transport for a loopback endpoint only. Credentials otherwise require HTTPS; unauthenticated HTTP sources remain supported. | |
acquisition_max_bytes |
No | integer | Maximum acquired original bytes, default 64 GiB. Declared and streamed lengths are bounded before publication. | |
acquisition_timeout_ms |
No | integer | Positive total acquisition deadline in milliseconds, default ten minutes. Per-item values override batch defaults. | |
transcript_max_bytes |
No | integer | Independent transcript acquisition and document byte ceiling (maximum 16 MiB). | |
transcript_timeout_ms |
No | integer | Independent transcript acquisition timeout in milliseconds. | |
attribution |
No | "auto", "native", "off", "diarize" | Preserve existing assignments; derive structured participation only when none exist. Diarize explicitly elects configured acoustic processing without recognition. | |
transcript_format |
No | "cueson", "srt", "vtt", "ass", "ssa" | Explicit native or Cue JSON format hint validated against input bytes. | |
replace_transcript |
No | boolean | Elect replacement when the target already has a current transcript. | |
subtitle_stream_index |
No | integer | Absolute embedded subtitle stream index to select. | |
subtitle_language |
No | string | Case-insensitive embedded subtitle language filter. | |
diarization_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
replace_audio |
No | boolean | Explicit election to replace canonical audio at an existing stable recording. | |
existing_transcript |
No | "keep", "clear", "replace" | Required document election when replacement has a current transcript. | |
transcript_applies |
No | boolean | Affirm that the current transcript applies to elected replacement audio. | |
existing_roster |
No | "retain", "clear" | Explicit declared-roster election during audio replacement. | |
known_speakers |
No | array | Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster. |
Disallowed combination: the condition matches.
defaults.known_speakers
Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster.
Value: array.
defaults.known_speakers[]
Value: string.
items
Inputs in deterministic admission order, with independent partial-result reporting.
Value: array.
items[]
Recording-date defaults and policies. Exact timestamp, calendar date and approximate UTC range are mutually exclusive.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
source |
No | string | Local source path or acquisition-adapter source locator. Credentials and temporary signed URLs must be resolved separately. | "audio/session.wav" |
subtitle |
No | string | Compatibility alias for transcript, with the same independent acquisition and validation contract. | "video/session.srt" |
originated_at |
No | Reference: common.schema.json#/$defs/wallTimestamp | Entered recording timestamp, distinct from import, publication and file modification times. | |
originated_on |
No | Reference: common.schema.json#/$defs/calendarDate | Entered recording date when the recording time is unknown. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Timezone for unzoned recording timestamps; local is resolved once for the batch. | |
dst_fold |
No | "earlier", "later" | Explicit choice of offset for an ambiguous repeated daylight-saving wall time. | |
dst_gap |
No | Constant "shift-forward" | Explicit policy to resolve a nonexistent wall time by shifting forward; absent means no silent correction. | |
copy |
No | boolean | True admits a managed copy into the selected artifact store; false keeps an explicitly tracked local reference. | |
preset |
No | string | Configured processing/import preset name or ID; does not embed provider configuration. | "local" |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional nonsecret input annotations. | |
title |
No | string | Optional library display title; source identity still comes from verified bytes. | |
new_entry |
No | boolean | Explicitly create another library entry even when this source was already admitted. Identical bytes can share the source asset. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Workspace-scoped acquisition credential reference, resolved privately by the configured adapter. | |
acquisition_adapter |
No | string | Explicit configured acquisition adapter; absent selects the source URI scheme without changing providers on failure. | |
date_precedence |
No | "owner-first", "embedded-first", "filesystem-fallback" | Versioned recording-date precedence rule. Filesystem modification becomes a recording-date candidate only under the explicit filesystem-fallback rule. | |
originated_earliest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive earliest recording instant for an owner-supplied approximate date range. Preserve the exact UTC timestamp and integer clock. | |
originated_latest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive latest recording instant for an owner-supplied approximate date range. Application validation checks bound ordering. | |
local_http |
No | boolean | Explicitly elect HTTP credential transport for a loopback endpoint only. Credentials otherwise require HTTPS; unauthenticated HTTP sources remain supported. | |
acquisition_max_bytes |
No | integer | Maximum acquired original bytes, default 64 GiB. Declared and streamed lengths are bounded before publication. | |
acquisition_timeout_ms |
No | integer | Positive total acquisition deadline in milliseconds, default ten minutes. Per-item values override batch defaults. | |
transcript_max_bytes |
No | integer | Independent transcript acquisition and document byte ceiling (maximum 16 MiB). | |
transcript_timeout_ms |
No | integer | Independent transcript acquisition timeout in milliseconds. | |
attribution |
No | "auto", "native", "off", "diarize" | Preserve existing assignments; derive structured participation only when none exist. Diarize explicitly elects configured acoustic processing without recognition. | |
transcript_format |
No | "cueson", "srt", "vtt", "ass", "ssa" | Explicit native or Cue JSON format hint validated against input bytes. | |
replace_transcript |
No | boolean | Elect replacement when the target already has a current transcript. | |
subtitle_stream_index |
No | integer | Absolute embedded subtitle stream index to select. | |
subtitle_language |
No | string | Case-insensitive embedded subtitle language filter. | |
diarization_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
transcript |
No | string | Independent local or authorized acquisition locator for native subtitles or Cue JSON. Explicit invalid input fails; it never falls back to embedded/generated text. | |
record |
No | string | Existing recording UUID or unambiguous exact title for standalone transcript admission. | |
transcript_credential_id |
No | Reference: common.schema.json#/$defs/uuid | Independent credential UUID for transcript acquisition. | |
transcript_adapter |
No | string | Explicit independent transcript acquisition adapter. | |
expected_revision |
No | integer | Optional observed target media revision for standalone transcript admission. | |
expected_recording_revision |
No | integer | Optional observed current document revision (zero means absent). | |
replace_audio |
No | boolean | Explicit election to replace canonical audio at an existing stable recording. | |
existing_transcript |
No | "keep", "clear", "replace" | Required document election when replacement has a current transcript. | |
transcript_applies |
No | boolean | Affirm that the current transcript applies to elected replacement audio. | |
existing_roster |
No | "retain", "clear" | Explicit declared-roster election during audio replacement. | |
known_speakers |
No | array | Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster. | |
kind |
No | "media", "transcript" | Media with record targets audio; transcript preserves the standalone source alias. | |
expected_roster_revision |
No | integer | Observed roster revision, zero for absent. |
Disallowed combination: the condition matches.
items[].known_speakers
Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster.
Value: array.
items[].known_speakers[]
Value: string.
Exactly one of the following alternatives must match:
items[]: media
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "media" | Selected input discriminator. |
Disallowed combination: has transcript, subtitle.
items[]: Alternative 2
Required fields: source.
Disallowed combination: the condition matches.
items[]: Alternative 3
Required fields: record.
Disallowed combination: kind is "media".
Exactly one of the following alternatives must match:
items[]: Alternative 3: Alternative 1
Required fields: source.
Disallowed combination: the condition matches.
items[]: Alternative 3: Alternative 2
Required fields: transcript.
Disallowed combination: the condition matches.
items[]: Alternative 3: Alternative 3
Required fields: subtitle.
Disallowed combination: the condition matches.
Definition: options
Recording-date defaults and policies. Exact timestamp, calendar date and approximate UTC range are mutually exclusive.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
originated_at |
No | Reference: common.schema.json#/$defs/wallTimestamp | Entered recording timestamp, distinct from import, publication and file modification times. | |
originated_on |
No | Reference: common.schema.json#/$defs/calendarDate | Entered recording date when the recording time is unknown. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Timezone for unzoned recording timestamps; local is resolved once for the batch. | |
dst_fold |
No | "earlier", "later" | Explicit choice of offset for an ambiguous repeated daylight-saving wall time. | |
dst_gap |
No | Constant "shift-forward" | Explicit policy to resolve a nonexistent wall time by shifting forward; absent means no silent correction. | |
copy |
No | boolean | True admits a managed copy into the selected artifact store; false keeps an explicitly tracked local reference. | |
preset |
No | string | Configured processing/import preset name or ID; does not embed provider configuration. | "local" |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional nonsecret input annotations. | |
date_precedence |
No | "owner-first", "embedded-first", "filesystem-fallback" | Versioned recording-date precedence rule. Filesystem modification becomes a recording-date candidate only under the explicit filesystem-fallback rule. | |
originated_earliest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive earliest recording instant for an owner-supplied approximate date range. Preserve the exact UTC timestamp and integer clock. | |
originated_latest |
No | Reference: common.schema.json#/$defs/utcInstant | Inclusive latest recording instant for an owner-supplied approximate date range. Application validation checks bound ordering. | |
local_http |
No | boolean | Explicitly elect HTTP credential transport for a loopback endpoint only. Credentials otherwise require HTTPS; unauthenticated HTTP sources remain supported. | |
acquisition_max_bytes |
No | integer | Maximum acquired original bytes, default 64 GiB. Declared and streamed lengths are bounded before publication. | |
acquisition_timeout_ms |
No | integer | Positive total acquisition deadline in milliseconds, default ten minutes. Per-item values override batch defaults. | |
transcript_max_bytes |
No | integer | Independent transcript acquisition and document byte ceiling (maximum 16 MiB). | |
transcript_timeout_ms |
No | integer | Independent transcript acquisition timeout in milliseconds. | |
attribution |
No | "auto", "native", "off", "diarize" | Preserve existing assignments; derive structured participation only when none exist. Diarize explicitly elects configured acoustic processing without recognition. | |
transcript_format |
No | "cueson", "srt", "vtt", "ass", "ssa" | Explicit native or Cue JSON format hint validated against input bytes. | |
replace_transcript |
No | boolean | Elect replacement when the target already has a current transcript. | |
subtitle_stream_index |
No | integer | Absolute embedded subtitle stream index to select. | |
subtitle_language |
No | string | Case-insensitive embedded subtitle language filter. | |
diarization_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
replace_audio |
No | boolean | Explicit election to replace canonical audio at an existing stable recording. | |
existing_transcript |
No | "keep", "clear", "replace" | Required document election when replacement has a current transcript. | |
transcript_applies |
No | boolean | Affirm that the current transcript applies to elected replacement audio. | |
existing_roster |
No | "retain", "clear" | Explicit declared-roster election during audio replacement. | |
known_speakers |
No | array | Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster. |
Disallowed combination: the condition matches.
Definition: options.known_speakers
Initial declared identities by UUID or unique exact canonical name/active alias. Empty declares an empty roster.
Value: array.
Definition: options.known_speakers[]
Value: string.
Example
{
"schema_version": "1.0.0",
"kind": "import-manifest",
"defaults": {
"copy": true,
"timezone": "America/New_York",
"preset": "local"
},
"items": [
{
"source": "audio/session.wav",
"originated_at": "2026-10-04T14:30:00"
},
{
"source": "video/session.mp4",
"originated_on": "2026-10-03",
"subtitle": "video/session.srt"
}
]
}
Example
{
"kind": "import-manifest",
"schema_version": "1.0.0",
"items": [
{
"source": "audio/new.flac",
"known_speakers": []
},
{
"kind": "media",
"source": "audio/replacement.flac",
"record": "44444444-4444-4444-8444-444444444444",
"replace_audio": true,
"existing_transcript": "keep",
"transcript_applies": true,
"existing_roster": "retain"
}
]
}
insonic durable job event
Versioned ordered event for a durable job/attempt. Event syntax does not establish a committed catalog or graph result: publication receipts/checkpoints and application state transitions retain that authority.
Download job-event.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this insonic document contract. | |
kind |
Yes | Constant "job-event" | Document discriminator registered by the master schema. | |
event_id |
Yes | Reference: common.schema.json#/$defs/uuid | Idempotent event identity for replay/deduplication. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace scope of the job. | |
job_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable durable job identity. | |
sequence |
Yes | Reference: common.schema.json#/$defs/revision | Strictly increasing sequence within this job event stream; application rejects duplicate/conflicting sequence content. | |
occurred_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC audit instant emitted by the runtime. | |
event_type |
Yes | "queued", "attempt-started", "stage-started", "progress", "artifact-published", "checkpoint", "completed", "failed", "cancelled", "publication-pending" | Declared event type controlling required detail fields. | |
state |
Yes | "queued", "running", "waiting", "cancelling", "cancelled", "failed", "succeeded", "publication-pending" | Durable application job state after the event; application enforces valid transitions. | |
attempt_id |
No | Reference: common.schema.json#/$defs/uuid | Producing attempt identity, absent before the first claim. | |
attempt_number |
No | integer | One-based attempt count for this job. | |
claim_generation |
No | Reference: common.schema.json#/$defs/revision | Fencing generation of the worker claim; stale claims cannot commit newer state. | |
stage_id |
No | string | Capability stage producing this event. | |
progress |
No | object | Adapter-reported progress; absence is distinct from zero progress. | |
artifact_refs |
No | array | Immutable artifact references produced by this event, not temporary paths. | |
checkpoint_id |
No | Reference: common.schema.json#/$defs/uuid | Catalog checkpoint record ID, including hosted checkpoints without downloadable bytes. | |
error |
No | object | Redacted actionable failure details; unknown commit outcomes remain explicitly reconcilable. | |
publication |
No | object | Catalog-to-graph publication state associated with this event. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced extension data without changing event/query authority. |
progress
Adapter-reported progress; absence is distinct from zero progress.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
fraction |
No | number | Fraction complete when the adapter supplies a meaningful denominator. | |
completed_units |
No | number | Nonnegative completed work quantity. | |
total_units |
No | number | Positive expected quantity when known; application additionally checks completed <= total. | |
unit |
No | string | Unit for quantities, such as seconds, segments or training steps. | |
message |
No | string | Plain-language progress message excluding secrets and full source/transcript payloads. |
artifact_refs
Immutable artifact references produced by this event, not temporary paths.
Value: array.
artifact_refs[]
Published logical artifact reference.
Value: Reference: common.schema.json#/$defs/artifactReference.
error
Redacted actionable failure details; unknown commit outcomes remain explicitly reconcilable.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
category |
Yes | "source-unavailable", "storage-unavailable", "catalog-unavailable", "graph-unavailable", "decode-failure", "capacity", "model-unavailable", "authentication", "quota", "invalid-output", "cancelled", "unknown-commit", "other" | Failure boundary used by recovery and user guidance. | |
code |
Yes | string | Stable adapter/application error code. | |
message |
Yes | string | Readable next-action message without credential values or whole transcripts. | |
retryable |
Yes | boolean | Whether the configured retry policy can retry this operation without rerouting. | |
operation_id |
No | Reference: common.schema.json#/$defs/uuid | Operation receipt to reconcile when commit status is unknown. |
publication
Catalog-to-graph publication state associated with this event.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
catalog_revision |
Yes | Reference: common.schema.json#/$defs/revision | Exact accepted catalog revision awaiting or completing projection. | |
target_profile |
Yes | Reference: common.schema.json#/$defs/backendProfileReference | Selected graph projection target. | |
status |
Yes | "pending", "committed", "reconciling" | Publication state; committed means the matching checkpoint has been verified. |
All of the following constraints apply:
When event_type is "queued":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "queued" | Durable application job state after the event; application enforces valid transitions. |
When event_type matches "attempt-started", "stage-started", "progress", "artifact-published", "checkpoint":
Value: object.
Required fields: attempt_id, attempt_number, claim_generation.
When event_type is "progress":
Value: object.
Required fields: progress.
When event_type is "artifact-published":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_refs |
Yes | array | Immutable artifact references produced by this event, not temporary paths. |
When event_type is "checkpoint":
Value: object.
Required fields: checkpoint_id.
When event_type is "completed":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "succeeded" | Durable application job state after the event; application enforces valid transitions. |
When event_type is "failed":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "failed" | Durable application job state after the event; application enforces valid transitions. |
When event_type is "cancelled":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "cancelled" | Durable application job state after the event; application enforces valid transitions. |
When event_type is "publication-pending":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "publication-pending" | Durable application job state after the event; application enforces valid transitions. | |
publication |
Yes | object | Catalog-to-graph publication state associated with this event. |
publication
Catalog-to-graph publication state associated with this event.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
status |
No | "pending", "reconciling" | Publication state; committed means the matching checkpoint has been verified. |
Example
{
"schema_version": "1.0.0",
"kind": "job-event",
"event_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"job_id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
"sequence": 3,
"occurred_at": {
"iso": "2026-10-04T18:32:00Z",
"unix_ns": 1791138720000000000
},
"event_type": "progress",
"state": "running",
"attempt_id": "cccccccc-cccc-4ccc-8ccc-cccccccccccc",
"attempt_number": 1,
"claim_generation": 1,
"stage_id": "transcribe",
"progress": {
"fraction": 0.5,
"completed_units": 30,
"total_units": 60,
"unit": "seconds"
}
}
insonic metadata extraction tools
Workspace metadata extractor configuration. Every configured executable has an absolute selected path, exact version and SHA-256. Hash/version qualification happens before extraction, and child processes use hidden noninteractive I/O. Missing or failed extractors record explicit capture outcomes while retaining usable original media.
Download media-tools.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "media-tools" | Workspace extractor-configuration discriminator. | |
schema_version |
Yes | Constant "1.0.0" | Insonic contract release version. | |
exiftool |
Yes | Reference: #/$defs/tool | Selected embedded-metadata extractor, preserving qualified groups, repeated tags and structured values. | |
ffprobe |
Yes | Reference: #/$defs/tool | Selected complementary stream/container probe, supplying measured source duration and clock facts. | |
ffmpeg |
No | Reference: #/$defs/tool | Optional exact mapped-audio decoder required only by selected processing operations. |
Definition: tool
One exact local executable selected for metadata extraction.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute executable path on this machine; executable selection is explicit and never inferred from an ambient PATH. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the selected executable bytes. | |
version |
Yes | string | Exact expected upstream version reported by the selected executable. | |
support_files |
No | array | Exact selected support files used by a launcher or interpreter bundle. Each file hash is checked before execution so launcher delegation cannot bypass the pinned package identity. | |
interpreter |
No | object | Optional exact absolute interpreter executable used to run the selected tool script, independently hash-qualified without ambient PATH or shebang lookup. |
Definition: tool.support_files
Exact selected support files used by a launcher or interpreter bundle. Each file hash is checked before execution so launcher delegation cannot bypass the pinned package identity.
Value: array.
Definition: tool.support_files[]
Optional exact absolute interpreter executable used to run the selected tool script, independently hash-qualified without ambient PATH or shebang lookup.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected support-file path within the installed extractor bundle. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of this exact support file. |
Definition: tool.interpreter
Optional exact absolute interpreter executable used to run the selected tool script, independently hash-qualified without ambient PATH or shebang lookup.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected support-file path within the installed extractor bundle. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of this exact support file. |
Example
{
"kind": "media-tools",
"schema_version": "1.0.0",
"exiftool": {
"path": "/opt/insonic/tools/exiftool",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"version": "13.37"
},
"ffprobe": {
"path": "/opt/insonic/tools/ffprobe",
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"version": "8.0"
}
}
insonic early media metadata snapshot
Immutable capture attempt bound to original media before transformations. It preserves raw extractor reports, qualified normalized observations, MIME interpretations and recording-date precision. Missing metadata differs from unsupported extraction or failure.
Download metadata-snapshot.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this capture contract. | |
kind |
Yes | Constant "metadata-snapshot" | Document discriminator used by the master registry. | |
snapshot_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable identity of the current capture report; refresh replaces it and retires superseded computed output. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace scope of the inspected source and observations. | |
source_asset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable inspected original asset identity. | |
source_artifact |
Yes | Reference: common.schema.json#/$defs/artifactReference | Exact inspected original bytes, with complete digest and length. | |
captured_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | Audit instant of this extraction attempt, not the recording date. | |
capture_state |
Yes | "captured", "no-embedded-metadata", "partial", "unsupported", "failed" | Explicit capture coverage/outcome. Only successful empty extraction establishes no-embedded-metadata. | |
extractor |
Yes | object | Exact capture tool/method and effective nonsecret options. | |
reports |
Yes | array | Immutable complete raw report/payload references when capture produced output. | |
observations |
Yes | array | Qualified normalized tag facts derived from retained raw reports. | |
mime_resolution |
No | object | Separate source observations and selected preferred MIME interpretation, preserving disagreements. | |
origination_observations |
No | array | Recording-date observations at admission. Mutable current selection lives in catalog revisions. | |
coverage |
Yes | object | Capture completeness details without claiming every format has EXIF. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced nonsecret capture annotations. |
source_artifact
Exact inspected original bytes, with complete digest and length.
Value: Reference: common.schema.json#/$defs/artifactReference.
All of the following constraints apply:
source_artifact: Alternative 1
Value: object.
Required fields: sha256, byte_length.
extractor
Exact capture tool/method and effective nonsecret options.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
extractor_id |
Yes | string | Extractor identity such as exiftool or ffprobe. | |
version |
Yes | string | Exact tool version used for this attempt. | |
options |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Capture options, including duplicate/group preservation and explicit limits. |
reports
Immutable complete raw report/payload references when capture produced output.
Value: array.
reports[]
Immutable raw extractor report or retained metadata payload. Application admission verifies complete digest and size.
Value: Reference: common.schema.json#/$defs/artifactReference.
All of the following constraints apply:
reports[]: Alternative 1
Value: object.
Required fields: sha256, byte_length.
observations
Qualified normalized tag facts derived from retained raw reports.
Value: array.
observations[]
A qualified incoming tag instance and normalized interpretation. Raw source content is evidence, never runtime instructions.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
observation_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable identity for this observed tag instance. | |
family |
Yes | string | Metadata family such as EXIF, XMP, ID3, RIFF/BWF or container. | |
group_path |
Yes | array | Ordered qualified group path retaining otherwise colliding tag names. | |
tag |
Yes | string | Tag name exactly qualified by group_path. | |
occurrence |
Yes | integer | Zero-based duplicate instance within the qualified tag path. | |
raw_value |
No | At least one alternative | Original JSON-representable value without replacing it with the normalized interpretation. | |
payload_artifact |
No | Reference: common.schema.json#/$defs/artifactReference | Immutable raw extractor report or retained metadata payload. Application admission verifies complete digest and size. | |
raw_report_pointer |
No | string | Optional pointer into a retained report, using that extractor's documented structure. | |
normalized |
No | object | Typed normalized value with method provenance; complete raw values remain separate. | |
warnings |
No | array | Uncertainty and coverage warnings associated with this observation. |
observations[].group_path
Ordered qualified group path retaining otherwise colliding tag names.
Value: array.
observations[].group_path[]
One instance-qualified metadata group component.
Value: string.
observations[].raw_value
Original JSON-representable value without replacing it with the normalized interpretation.
At least one of the following alternatives must match:
observations[].raw_value: Alternative 1
Value: string.
observations[].raw_value: Alternative 2
Value: number.
observations[].raw_value: Alternative 3
Value: boolean.
observations[].raw_value: Alternative 4
Value: null.
observations[].raw_value: Alternative 5
Value: object.
observations[].raw_value: Alternative 6
Value: array.
observations[].payload_artifact
Immutable raw extractor report or retained metadata payload. Application admission verifies complete digest and size.
Value: Reference: common.schema.json#/$defs/artifactReference.
All of the following constraints apply:
observations[].payload_artifact: Alternative 1
Value: object.
Required fields: sha256, byte_length.
observations[].normalized
Typed normalized value with method provenance; complete raw values remain separate.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value_type |
Yes | "text", "integer", "number", "boolean", "instant", "date", "bytes", "object", "list", "unknown" | Declared logical type for value. | |
value |
Yes | At least one alternative | Normalized value matching value_type; adapter/application validation enforces domain-specific semantics. | |
method |
Yes | string | Normalization resolver/method identity. | |
method_version |
Yes | string | Version of the normalization method. | |
units |
No | string | Explicit units where relevant. | |
precision |
No | string | Declared source precision; normalization does not invent greater precision. |
observations[].normalized.value
Normalized value matching value_type; adapter/application validation enforces domain-specific semantics.
At least one of the following alternatives must match:
observations[].normalized.value: Alternative 1
Value: string.
observations[].normalized.value: Alternative 2
Value: number.
observations[].normalized.value: Alternative 3
Value: boolean.
observations[].normalized.value: Alternative 4
Value: null.
observations[].normalized.value: Alternative 5
Value: object.
observations[].normalized.value: Alternative 6
Value: array.
All of the following constraints apply:
When value_type is "text":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | string | Value normalized as text; raw observations remain preserved independently. |
When value_type is "integer":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | integer | Value normalized as integer; raw observations remain preserved independently. |
When value_type is "number":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | number | Value normalized as number; raw observations remain preserved independently. |
When value_type is "boolean":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | boolean | Value normalized as boolean; raw observations remain preserved independently. |
When value_type is "instant":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/utcInstant | Value normalized as instant; raw observations remain preserved independently. |
When value_type is "date":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/calendarDate | Value normalized as date; raw observations remain preserved independently. |
When value_type is "bytes":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | string | Value normalized as bytes; raw observations remain preserved independently. |
When value_type is "object":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | object | Value normalized as object; raw observations remain preserved independently. |
When value_type is "list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | array | Value normalized as list; raw observations remain preserved independently. |
When value_type is "unknown":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | null | Value normalized as unknown; raw observations remain preserved independently. |
observations[].warnings
Uncertainty and coverage warnings associated with this observation.
Value: array.
observations[].warnings[]
Readable coverage or interpretation warning without credentials.
Value: string.
At least one of the following alternatives must match:
observations[]: Alternative 1
Value: object.
Required fields: raw_value.
observations[]: Alternative 2
Value: object.
Required fields: payload_artifact.
mime_resolution
Separate source observations and selected preferred MIME interpretation, preserving disagreements.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
resolver_id |
Yes | string | MIME resolver identity. | |
resolver_version |
Yes | string | MIME resolver version. | |
preferred_mime_type |
Yes | string | Selected useful MIME type, without discarding conflicting observations. | |
disagreement |
Yes | boolean | Whether observed source/type facts disagree. | |
observations |
Yes | array | Observed file/type facts with their distinct origins. |
mime_resolution.observations
Observed file/type facts with their distinct origins.
Value: array.
mime_resolution.observations[]
One type observation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
basis |
Yes | "filename-extension", "acquisition-declared", "byte-detected", "extractor-file-type", "probed-container", "owner" | Origin of the type fact. | |
value |
Yes | string | Original observed extension/type/container value. | |
metadata_observation_id |
No | Reference: common.schema.json#/$defs/uuid | Related detailed tag/probe observation if present. |
origination_observations
Recording-date observations at admission. Mutable current selection lives in catalog revisions.
Value: array.
origination_observations[]
Immutable origination observation retaining the received/entered literal and its explicit timezone interpretation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
observation_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable date-observation identity. | |
basis |
Yes | "owner", "embedded", "interpretation-policy" | Source of this recording-date assertion, separate from import/publication times. | |
metadata_observation_id |
No | Reference: common.schema.json#/$defs/uuid | Supporting embedded tag observation when available. | |
entered_literal |
Yes | string | Original entered or received date/time text, preserved before interpretation. | |
precision |
Yes | "instant", "day", "month", "year", "range", "unknown" | Precision actually supplied by the owner/source; date-only inputs are not recording instants. | |
interpretation_state |
Yes | "resolved", "date-only", "approximate", "ambiguous", "nonexistent", "invalid", "unknown" | Resolution result, including explicit DST/parse uncertainty. | |
wall_time |
No | Reference: common.schema.json#/$defs/wallTimestamp | Parsed wall timestamp, including a supplied offset when present. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Captured effective IANA zone or offset; the unresolved selector local is not valid in a persisted interpreted capture. | |
zone_source |
No | "entered", "embedded", "import-policy", "unknown" | Basis for the effective zone. | |
resolved_offset |
No | string | Numeric offset selected for the interpreted wall time. | |
timezone_database_version |
No | string | IANA rule database version used for regional-zone interpretation. | |
calendar_date |
No | Reference: common.schema.json#/$defs/calendarDate | Normalized date with day precision, without inventing a known recording time. | |
calendar_month |
No | string | Normalized calendar month when day precision is unavailable. | |
calendar_year |
No | integer | Normalized year when month/day precision is unavailable. | |
utc_instant |
No | Reference: common.schema.json#/$defs/utcInstant | Resolved precise recording instant, present only for instant precision. | |
bounds |
No | object | Optional UTC interpretation bounds for an approximate period. Application checks ordering and preserves the calendar precision. | |
policy_version |
Yes | string | Date candidate/timezone interpretation policy version. | |
assumption_flags |
No | array | Visible assumptions such as a batch-timezone interpretation. |
origination_observations[].timezone
Captured effective IANA zone or offset; the unresolved selector local is not valid in a persisted interpreted capture.
Value: Reference: common.schema.json#/$defs/timezone.
All of the following constraints apply:
origination_observations[].timezone: Alternative 1
Disallowed combination: the condition matches.
origination_observations[].bounds
Optional UTC interpretation bounds for an approximate period. Application checks ordering and preserves the calendar precision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
earliest |
No | Reference: common.schema.json#/$defs/utcInstant | Earliest supported UTC bound. | |
latest |
No | Reference: common.schema.json#/$defs/utcInstant | Latest supported UTC bound. |
At least one of the following alternatives must match:
origination_observations[].bounds: Alternative 1
Value: object.
Required fields: earliest.
origination_observations[].bounds: Alternative 2
Value: object.
Required fields: latest.
origination_observations[].assumption_flags
Visible assumptions such as a batch-timezone interpretation.
Value: array.
origination_observations[].assumption_flags[]
Explicit assumption applied during interpretation.
Value: string.
All of the following constraints apply:
When precision is "day":
Value: object.
Required fields: calendar_date.
Disallowed combination: has utc_instant.
When precision is "month":
Value: object.
Required fields: calendar_month.
Disallowed combination: has utc_instant.
When precision is "year":
Value: object.
Required fields: calendar_year.
Disallowed combination: has utc_instant.
When precision is "range":
Value: object.
Required fields: bounds.
Disallowed combination: has utc_instant.
When interpretation_state is "resolved":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
precision |
No | Constant "instant" | Declared source precision; normalization does not invent greater precision. |
When interpretation_state matches "ambiguous", "nonexistent", "invalid", "unknown":
Disallowed combination: has utc_instant.
When precision matches Structured value:
Disallowed combination: has utc_instant.
When interpretation_state is "date-only":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
precision |
No | "day", "month", "year" | Declared source precision; normalization does not invent greater precision. |
coverage
Capture completeness details without claiming every format has EXIF.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
families |
Yes | array | Families actually inspected. | |
truncated |
Yes | boolean | Whether limits omitted source fields/payloads. | |
warnings |
Yes | array | Recorded coverage and error warnings. |
coverage.families
Families actually inspected.
Value: array.
coverage.families[]
Metadata family inspected.
Value: string.
coverage.warnings
Recorded coverage and error warnings.
Value: array.
coverage.warnings[]
Readable extraction limitation or failure description.
Value: string.
All of the following constraints apply:
When capture_state matches "captured", "no-embedded-metadata", "partial":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
reports |
No | array | Immutable complete raw report/payload references when capture produced output. |
When capture_state is "no-embedded-metadata":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
observations |
No | array | Qualified normalized tag facts derived from retained raw reports. | |
coverage |
No | object | Capture completeness details without claiming every format has EXIF. |
coverage
Capture completeness details without claiming every format has EXIF.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
truncated |
No | Constant false | Whether limits omitted source fields/payloads. |
When capture_state is "captured":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
coverage |
No | object | Capture completeness details without claiming every format has EXIF. |
coverage
Capture completeness details without claiming every format has EXIF.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
truncated |
No | Constant false | Whether limits omitted source fields/payloads. |
When coverage matches object:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
capture_state |
No | Constant "partial" | Explicit capture coverage/outcome. Only successful empty extraction establishes no-embedded-metadata. |
Example
{
"schema_version": "1.0.0",
"kind": "metadata-snapshot",
"snapshot_id": "77777777-7777-4777-8777-777777777777",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"source_asset_id": "88888888-8888-4888-8888-888888888888",
"source_artifact": {
"artifact_id": "99999999-9999-4999-8999-999999999999",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"byte_length": 1048576
},
"captured_at": {
"iso": "2026-10-04T18:31:00Z",
"unix_ns": 1791138660000000000
},
"capture_state": "captured",
"extractor": {
"extractor_id": "metadata-adapter",
"version": "1",
"options": {
"qualified_groups": true
}
},
"reports": [
{
"artifact_id": "22222222-2222-4222-8222-222222222222",
"sha256": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
"byte_length": 4096
}
],
"observations": [
{
"observation_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
"family": "container",
"group_path": [
"QuickTime",
"Movie"
],
"tag": "CreateDate",
"occurrence": 0,
"raw_value": "2026:10:04 14:30:00",
"normalized": {
"value_type": "text",
"value": "2026:10:04 14:30:00",
"method": "preserve-literal",
"method_version": "1"
}
}
],
"mime_resolution": {
"resolver_id": "media-type",
"resolver_version": "1",
"preferred_mime_type": "video/mp4",
"disagreement": false,
"observations": [
{
"basis": "byte-detected",
"value": "video/mp4"
}
]
},
"origination_observations": [
{
"observation_id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
"basis": "owner",
"entered_literal": "2026-10-04",
"precision": "day",
"interpretation_state": "date-only",
"calendar_date": "2026-10-04",
"timezone": "America/New_York",
"zone_source": "import-policy",
"policy_version": "1"
}
],
"coverage": {
"families": [
"container"
],
"truncated": false,
"warnings": []
}
}
Configured model source catalog
Declared bounded metadata catalog.
Download model-catalog.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "model-catalog" | Configured source metadata discriminator. | |
schema_version |
Yes | Constant "1.0.0" | Shared release contract version. | |
entries |
Yes | array | Source catalog entries; the runtime additionally bounds total metadata to four MiB. |
entries
Source catalog entries; the runtime additionally bounds total metadata to four MiB.
Value: array.
entries[]
One selectable pinned bundle.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
selector |
Yes | string | Exact source-local selector; unique within this catalog. | |
manifest |
Yes | Reference: base-model-manifest.schema.json | Complete pinned model bundle with all required files. |
Example
{
"kind": "model-catalog",
"schema_version": "1.0.0",
"entries": []
}
insonic pipeline configuration
Saved revision of elected processing stages or speaker-training profile; shared runtime freezes effective adapter/settings identity.
Download pipeline-config.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Schema version. | |
kind |
Yes | Constant "pipeline-config" | Kind. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
name |
Yes | string | Name. | |
preset |
Yes | "local", "connected", "custom" | Preset. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Revision. | |
configuration |
Yes | Reference: #/$defs/configuration | Configuration. |
All of the following constraints apply:
When preset is "local":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | object | Preset-compatible worker routes. |
configuration
Preset-compatible worker routes.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recognition |
No | object | Preset-compatible stage. | |
diarization |
No | object | Preset-compatible stage. |
configuration.recognition
Preset-compatible stage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
No | Constant "local" | Elected execution route. |
configuration.diarization
Preset-compatible stage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
No | Constant "local" | Elected execution route. |
When preset is "connected":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | object | Preset-compatible worker routes. |
configuration
Preset-compatible worker routes.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recognition |
No | object | Preset-compatible stage. | |
diarization |
No | object | Preset-compatible stage. |
configuration.recognition
Preset-compatible stage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
No | Constant "hosted" | Elected execution route. |
configuration.diarization
Preset-compatible stage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
No | Constant "hosted" | Elected execution route. |
Definition: configuration
Saved worker selections and optional quality configuration. Defaults are normalized when an immutable election is submitted.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recognition |
No | Reference: #/$defs/recognitionStage | Recognition. | |
diarization |
No | Reference: #/$defs/diarizationStage | Diarization. | |
quality |
No | Reference: #/$defs/quality | Quality. | |
speaker_training |
No | object | Saved speaker-training profile, independent of recognition and diarization. |
Definition: configuration.speaker_training
Saved speaker-training profile, independent of recognition and diarization.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | Reference: runtime-request.schema.json#/$defs/speakerAdapter | Exact elected speaker training adapter declaration. | |
base_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Optional selected base model reference. | |
output_kind |
Yes | string | Declared desired output kind. | |
parameters |
No | Reference: common.schema.json#/$defs/nonsecretOptions | Effective training parameters. |
At least one of the following alternatives must match:
Definition: configuration: Alternative 1
Required fields: recognition, diarization.
Definition: configuration: Alternative 2
Required fields: speaker_training.
Definition: stage
A selected local or hosted worker. Semantic validation verifies endpoint authority, capability compatibility, routing and option relationships.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | "faster-whisper", "pyannote", "insonic-http" | Adapter. | |
contract_version |
Yes | Constant "1" | Contract version. | |
mode |
Yes | "local", "hosted" | Mode. | |
model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
remote_model |
No | string | Remote model. | |
endpoint |
No | string | Endpoint. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Id. | |
capabilities |
No | array | Capabilities. | |
supports_hints |
No | boolean | Supports hints. | |
max_hint_bytes |
No | integer | Max hint bytes. | |
limits |
No | Reference: #/$defs/limits | Limits. | |
recognition |
No | Reference: #/$defs/recognitionOptions | Recognition. | |
diarization |
No | Reference: #/$defs/diarizationOptions | Diarization. |
Definition: stage.capabilities
Capabilities.
Value: array.
Definition: stage.capabilities[]
Value: "transcription", "diarization".
All of the following constraints apply:
When mode is "local":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
No | "faster-whisper", "pyannote" | Adapter. |
Disallowed combination: the condition matches.
When mode is "hosted":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
No | Constant "insonic-http" | Adapter. | |
recognition |
No | object | Recognition. | |
diarization |
No | object | Diarization. |
Disallowed combination: the condition matches.
When supports_hints is true:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
capabilities |
No | array | Capabilities. |
Otherwise:
Disallowed combination: the condition matches.
Definition: recognitionStage
Value: object.
All of the following constraints apply:
Definition: recognitionStage: Alternative 1
Value: Reference: #/$defs/stage.
When mode is "local":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
No | Constant "faster-whisper" | Adapter. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
capabilities |
No | array | Capabilities. |
Definition: diarizationStage
Value: object.
All of the following constraints apply:
Definition: diarizationStage: Alternative 1
Value: Reference: #/$defs/stage.
When mode is "local":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
No | Constant "pyannote" | Adapter. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
capabilities |
No | array | Capabilities. |
Definition: recognitionOptions
Recognition options. The runtime verifies UTF-8 joined hint byte limits and digest agreement.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
device |
No | "cpu", "cuda" | Device. | |
language |
No | string | Language. | |
hints |
No | array | Hints. | |
context_digest |
No | Reference: common.schema.json#/$defs/sha256 | Context digest. |
Definition: recognitionOptions.hints
Hints.
Value: array.
Definition: recognitionOptions.hints[]
Value: string.
Definition: diarizationOptions
Diarization options; zero maximum means unconstrained. Runtime verifies minimum does not exceed a positive maximum.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
device |
No | "cpu", "cuda" | Device. | |
min_speakers |
No | integer | Min speakers. | |
max_speakers |
No | integer | Max speakers. |
Definition: quality
Optional quality policy; omitted values use enabled checks and a 250000 microsecond short-turn threshold. Mandatory document validation is independent.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
enabled |
No | boolean | Enabled. | |
min_speech_coverage |
No | number | Min speech coverage. | |
max_overlap_fraction |
No | number | Max overlap fraction. | |
short_turn_us |
No | integer | Short turn us. |
Definition: limits
Explicit execution ceilings; omitted values use 128 MiB input, 16 MiB response and 600000 millisecond timeout.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
max_audio_bytes |
No | integer | Max audio bytes. | |
max_response_bytes |
No | integer | Max response bytes. | |
timeout_ms |
No | integer | Timeout ms. |
Definition: overrides
Full replacement of each supplied stage or quality policy; omitted sections retain the saved revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recognition |
No | Reference: #/$defs/recognitionStage | Recognition. | |
diarization |
No | Reference: #/$defs/diarizationStage | Diarization. | |
quality |
No | Reference: #/$defs/quality | Quality. |
Definition: entity
Stable saved pipeline with monotonic revision. Expected revision controls mutation; new input revision may be omitted or zero.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
name |
Yes | string | Name. | |
preset |
Yes | "local", "connected", "custom" | Preset. | |
revision |
No | integer | Revision. | |
configuration |
Yes | Reference: #/$defs/configuration | Configuration. |
Example
{
"schema_version": "1.0.0",
"kind": "pipeline-config",
"id": "66666666-6666-4666-8666-666666666666",
"name": "Local transcription and diarization",
"preset": "local",
"revision": 1,
"configuration": {
"recognition": {
"adapter": "faster-whisper",
"contract_version": "1",
"mode": "local",
"model_id": "11111111-1111-4111-8111-111111111111"
},
"diarization": {
"adapter": "pyannote",
"contract_version": "1",
"mode": "local",
"model_id": "22222222-2222-4222-8222-222222222222"
},
"quality": {}
}
}
Local processing tools
Exact local Cueson and optional offline engine configuration. Real inference is maintainer-elected and excluded categorically from CI.
Download processing-tools.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "processing-tools" | Processing configuration discriminator. | |
schema_version |
Yes | Constant "1.0.0" | Shared release version. | |
cueson |
Yes | object | Exact selected native subtitle encoder. | |
portable_files |
No | array | Destination-local hash-pinned custom adapter and support files used to resume portable work. Paths remain outside portable bundles; standard tool roles use the destination's selected tools. | |
processing |
Yes | object | Lazy selected processing tools and bounded execution budgets. Engines are required only by explicitly elected inference operations. |
cueson
Exact selected native subtitle encoder.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
executable |
Yes | string | Absolute selected Cueson executable path. | |
executable_sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the native encoder. |
portable_files
Destination-local hash-pinned custom adapter and support files used to resume portable work. Paths remain outside portable bundles; standard tool roles use the destination's selected tools.
Value: array.
portable_files[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected destination-local file path. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the custom adapter or support file. |
processing
Lazy selected processing tools and bounded execution budgets. Engines are required only by explicitly elected inference operations.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
ffmpeg |
No | Reference: media-tools.schema.json#/$defs/tool | Optional decoder override; otherwise use the workspace media-tool decoder. | |
recognition_python |
No | object | Selected isolated recognition Python executable. | |
diarization_python |
No | object | Selected isolated diarization Python executable. | |
worker |
No | object | Selected offline local processing worker script. | |
max_input_bytes |
No | integer | Maximum source size; default 64 GiB. | |
max_duration_us |
No | integer | Maximum mapped duration; default one hour. | |
max_output_bytes |
No | integer | Maximum worker response bytes; default 16 MiB. | |
timeout_ms |
No | integer | Maximum worker wall time; default ten minutes. | |
threads |
No | integer | Maximum selected inference CPU thread count; default two. |
processing.recognition_python
Selected isolated recognition Python executable.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected path without ambient executable lookup. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the selected file. |
processing.diarization_python
Selected isolated diarization Python executable.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected path without ambient executable lookup. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the selected file. |
processing.worker
Selected offline local processing worker script.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Absolute selected path without ambient executable lookup. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected lowercase SHA-256 of the selected file. |
Example
{
"kind": "processing-tools",
"schema_version": "1.0.0",
"cueson": {
"executable": "/opt/insonic/tools/cueson",
"executable_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"portable_files": [
{
"path": "/opt/insonic/speaker-adapter.py",
"sha256": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
}
],
"processing": {
"recognition_python": {
"path": "/opt/insonic/recognition/bin/python",
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
"diarization_python": {
"path": "/opt/insonic/diarization/bin/python",
"sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
},
"worker": {
"path": "/opt/insonic/processing-worker.py",
"sha256": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd"
},
"timeout_ms": 600000,
"threads": 2
}
}
Query assistance configuration
Optional elected query assistance and its strict request contract. Secret values and result snapshots are excluded.
Download query-assistance.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Shared release version. | |
kind |
Yes | Constant "query-assistance" | Master registry discriminator. | |
configuration |
Yes | Reference: #/$defs/configuration | Elected nonsecret provider configuration. |
Definition: configuration
Nonsecret optional provider settings.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
enabled |
No | boolean | Explicit provider election. | |
adapter |
No | "insonic-http" | Versioned adapter contract. | |
contract_version |
No | Constant "1" | Provider contract version. | |
route |
No | "local", "hosted" | Explicit destination class; local requires loopback. | |
endpoint |
No | string | Absolute elected HTTP(S) destination. | |
model |
No | string | Provider model identifier. | |
credential_id |
No | string | Opaque credential reference; no secret values. | |
mode |
No | "suggest", "auto-run" | Suggest by default, elected validated execution. | |
limits |
No | Reference: #/$defs/limits | Finite resource ceilings; omitted values receive defaults. |
Definition: request
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
prompt |
Yes | string | User request sent only to elected route. | |
configuration |
No | Reference: #/$defs/configuration | Elected nonsecret provider configuration. | |
settings_revision |
No | integer | Optional saved-setting revision fence. | |
mode |
No | "suggest", "auto-run" | Explicit request execution election. | |
context_query |
No | Reference: runtime-request.schema.json#/$defs/exploreQuery | Explicit bounded normalized excerpt query. |
Definition: setting
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Compare-and-swap revision. | |
configuration |
Yes | Reference: #/$defs/configuration | Elected nonsecret provider configuration. |
Definition: limits
Optional limits configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
timeout_ms |
No | integer | Finite timeout ms bound. | |
query_timeout_ms |
No | integer | Finite query timeout ms bound. | |
max_prompt_bytes |
No | integer | Finite max prompt bytes bound. | |
max_response_bytes |
No | integer | Finite max response bytes bound. | |
max_rows |
No | integer | Finite max rows bound. | |
max_result_bytes |
No | integer | Finite max result bytes bound. | |
max_context_rows |
No | integer | Finite max context rows bound. | |
max_context_bytes |
No | integer | Finite max context bytes bound. |
Example
{
"schema_version": "1.0.0",
"kind": "query-assistance",
"configuration": {
"enabled": false,
"adapter": "insonic-http",
"contract_version": "1",
"route": "local",
"endpoint": "",
"model": "",
"mode": "suggest"
}
}
insonic current recording
Current embedded Cueson subtitle and recording-local speaker assignments with revision-fenced external known-speaker correlations. Names, aliases and vocabulary remain independent current catalog domains; assignments are resolved only from the current document. Replacements invalidate dependent corpus and preparation references while preserving originals and noncontent model lineage.
Download recording.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "recording" | Master document discriminator. | |
schema_version |
Yes | Constant "1.0.0" | Insonic release version. | |
recording |
Yes | Reference: #/$defs/current | Current recording authority. | |
mappings |
Yes | array | External known-speaker mappings. |
mappings
External known-speaker mappings.
Value: array.
mappings[]
Value: Reference: #/$defs/mapping.
Definition: current
The sole current embedded subtitle and speaker-assignment authority for a library entry.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Library entry and current recording identity. | |
revision |
Yes | integer | Accepted catalog revision. | |
source_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Original source-media identity. | |
source_revision |
Yes | integer | Source library revision checked during publication. | |
state |
Yes | "ready", "no-speech", "no-timed-subtitles", "untranscribed" | Explicit representable subtitle outcome; no invented cues. | |
document |
Yes | At least one alternative | Sole current Cue JSON. Null means the explicit outcome has no representable document. Local exact packaged Cueson validation also enforces timing and source identity. | |
document_digest |
Yes | string | Exact current document SHA-256, empty only for null documents. | |
mapped_audio_publication_id |
Yes | At least one alternative | Current mapped audio publication or explicit absence. | |
source_map |
Yes | object | Exact integer/rational source-to-decoded-audio mapping; never speaker turns. | |
provenance |
Yes | object | Current noncontent engine, model, settings and source evidence. No transcript or assignment copies. | |
diagnostics |
Yes | array | Current quality/projection diagnostics, separate from document validity. |
Definition: current.document
Sole current Cue JSON. Null means the explicit outcome has no representable document. Local exact packaged Cueson validation also enforces timing and source identity.
At least one of the following alternatives must match:
Definition: current.document: Alternative 1
Value: Reference: https://cueson.io/schema/v1.2.0/cueson.schema.json.
Definition: current.document: Alternative 2
Value: null.
Definition: current.mapped_audio_publication_id
Current mapped audio publication or explicit absence.
At least one of the following alternatives must match:
Definition: current.mapped_audio_publication_id: Alternative 1
Managed current mapped audio publication.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: current.mapped_audio_publication_id: Alternative 2
Value: null.
Definition: current.diagnostics
Current quality/projection diagnostics, separate from document validity.
Value: array.
Definition: current.diagnostics[]
One bounded operational diagnostic.
Value: object.
All of the following constraints apply:
When state is "ready":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
document |
No | object | Conditional document constraint for explicit current-document state. | |
document_digest |
No | string | Conditional document_digest constraint for explicit current-document state. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
document |
No | null | Conditional document constraint for explicit current-document state. | |
document_digest |
No | Constant "" | Conditional document_digest constraint for explicit current-document state. |
Definition: mapping
External recording-local speaker token to known speaker correlation, without timed assignments.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Deterministic mapping identity. | |
recording_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current recording identity. | |
local_speaker_id |
Yes | Reference: common.schema.json#/$defs/localSpeakerID | Recording-local speaker token referenced inside embedded Cue JSON. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Known catalog speaker identity. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Current referenced document identity. | |
revision |
Yes | integer | Accepted external mapping revision. | |
origin |
No | "manual", "automatic" | Manual correction or automatic acoustic match; historical absence means manual. | |
provenance |
No | Reference: common.schema.json#/$defs/nonsecretOptions | Bounded current matching provenance without copied assignments or secrets. |
Example
{
"kind": "recording",
"schema_version": "1.0.0",
"recording": {
"id": "10000000-0000-4000-8000-000000000001",
"revision": 1,
"source_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_revision": 1,
"state": "no-speech",
"document": null,
"document_digest": "",
"mapped_audio_publication_id": null,
"source_map": {},
"provenance": {},
"diagnostics": []
},
"mappings": []
}
Verified native release candidate
Exact-version complete native package and documentation inventory. Structural validation complements source revision, corresponding-source, signing, checksum and publication readback checks. Synthetic examples illustrate shape and do not represent a shipped release.
Download release-candidate.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "release-candidate" | Complete verified release candidate manifest. | |
schema_version |
Yes | Constant "1.0.0" | Synchronized contract version. | |
version |
Yes | Constant "1.0.0" | Software, documentation and master-schema release version. | |
revision |
Yes | string | Exact clean source commit. | |
tag |
Yes | Constant "v1.0.0" | Exact release tag; baseline candidates are never published as a product release. | |
repository |
Yes | Constant "shruggietech/insonic" | Release publication repository. | |
packages |
Yes | array | All three native platforms and both variants. Runtime verifies unique matrix identities, inventory and corresponding-source proof. | |
assets |
Yes | array | Six native packages plus exact public documentation and offline-help archives; checksums and this manifest are companion assets. | |
capabilities |
Yes | object | CLI/GUI and qualification disposition. |
packages
All three native platforms and both variants. Runtime verifies unique matrix identities, inventory and corresponding-source proof.
Value: array.
packages[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "native-package-receipt" | Native package qualification receipt. | |
schema_version |
Yes | Constant "1.0.0" | Release contract version. | |
product_version |
Yes | Constant "1.0.0" | Owned software version. | |
documentation_version |
Yes | Constant "1.0.0" | Packaged documentation version. | |
platform |
Yes | "windows_amd64", "linux_amd64", "darwin_arm64" | Qualified native operating system and architecture. | |
variant |
Yes | "cli", "desktop" | CLI-only or GUI-with-CLI distribution. | |
revision |
Yes | string | Exact reviewed source commit. | |
source_dirty |
Yes | Constant false | Candidate source must be clean. | |
archive |
Yes | string | Portable archive basename. | |
archive_sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Final archive digest after configured signing. | |
archive_size_bytes |
Yes | integer | Exact archive byte count. | |
inventory_sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Final package inventory digest. | |
distribution |
Yes | object | Verified distribution disposition; detailed source inventory is inside the package. | |
signing |
Yes | object | Publisher signing evidence, distinct from operating-system ad-hoc sealing. |
packages[].distribution
Verified distribution disposition; detailed source inventory is inside the package.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
source_complete |
Yes | Constant true | Exact corresponding sources and build material verified. | |
binary_publication |
Yes | Constant "eligible" | Corresponding-source publication gate passed. | |
corresponding_source |
Yes | Constant "included" | Source material travels inside the package. |
packages[].signing
Publisher signing evidence, distinct from operating-system ad-hoc sealing.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configured |
Yes | boolean | Explicit publisher signing configuration exists. | |
verified |
Yes | boolean | Configured signing was verified. | |
status |
Yes | "unconfigured", "signed", "notarized" | Truthful publisher signing status; ad-hoc signatures do not imply publisher signing. |
All of the following constraints apply:
When configured is true:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
verified |
No | Constant true | Configured publisher signing must be verified before release. | |
status |
No | "signed", "notarized" | Configured signing requires a signed or notarized disposition. |
Otherwise:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
verified |
No | Constant false | Unconfigured signing cannot assert publisher verification. | |
status |
No | Constant "unconfigured" | No publisher signing identity was configured. |
assets
Six native packages plus exact public documentation and offline-help archives; checksums and this manifest are companion assets.
Value: array.
assets[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
name |
Yes | string | Safe immutable release asset basename. | |
size_bytes |
Yes | integer | Exact byte length. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Complete asset SHA-256. |
capabilities
CLI/GUI and qualification disposition.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
variants |
Yes | array | Qualified native variants. | |
platforms |
Yes | array | Qualified operating systems and architectures. | |
advanced_cli |
Yes | array | Advanced CLI capabilities awaiting dedicated GUI controls. | |
inference_qualification |
Yes | Constant "not-executed" | Required package checks do not initialize models or execute acoustic inference. |
capabilities.variants
Qualified native variants.
Value: array.
capabilities.variants[]
Value: "cli", "desktop".
capabilities.platforms
Qualified operating systems and architectures.
Value: array.
capabilities.platforms[]
Value: "windows_amd64", "linux_amd64", "darwin_arm64".
capabilities.advanced_cli
Advanced CLI capabilities awaiting dedicated GUI controls.
Value: array.
capabilities.advanced_cli[]
Value: string.
Example
{
"kind": "release-candidate",
"schema_version": "1.0.0",
"version": "1.0.0",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"tag": "v1.0.0",
"repository": "shruggietech/insonic",
"packages": [
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "windows_amd64",
"variant": "cli",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_windows_amd64_cli.zip",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
},
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "windows_amd64",
"variant": "desktop",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_windows_amd64_desktop.zip",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
},
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "linux_amd64",
"variant": "cli",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_linux_amd64_cli.tar.gz",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
},
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "linux_amd64",
"variant": "desktop",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_linux_amd64_desktop.tar.gz",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
},
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "darwin_arm64",
"variant": "cli",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_darwin_arm64_cli.zip",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
},
{
"kind": "native-package-receipt",
"schema_version": "1.0.0",
"product_version": "1.0.0",
"documentation_version": "1.0.0",
"platform": "darwin_arm64",
"variant": "desktop",
"revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"source_dirty": false,
"archive": "insonic_1.0.0_darwin_arm64_desktop.zip",
"archive_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"archive_size_bytes": 1,
"inventory_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"distribution": {
"source_complete": true,
"binary_publication": "eligible",
"corresponding_source": "included"
},
"signing": {
"configured": false,
"verified": false,
"status": "unconfigured"
}
}
],
"assets": [
{
"name": "insonic_1.0.0_windows_amd64_cli.zip",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "insonic_1.0.0_windows_amd64_desktop.zip",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "insonic_1.0.0_linux_amd64_cli.tar.gz",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "insonic_1.0.0_linux_amd64_desktop.tar.gz",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "insonic_1.0.0_darwin_arm64_cli.zip",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "insonic_1.0.0_darwin_arm64_desktop.zip",
"size_bytes": 1,
"sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
{
"name": "documentation.tar.gz",
"size_bytes": 1,
"sha256": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd"
},
{
"name": "offline-help.tar.gz",
"size_bytes": 1,
"sha256": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd"
}
],
"capabilities": {
"variants": [
"cli",
"desktop"
],
"platforms": [
"windows_amd64",
"linux_amd64",
"darwin_arm64"
],
"advanced_cli": [
"backup"
],
"inference_qualification": "not-executed"
}
}
Runtime request
A bounded local runtime operation correlated to a workspace and request. Job operations use durable catalog attempts and idempotent acceptance.
Download runtime-request.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Shared software and contract version. | |
kind |
Yes | Constant "runtime-request" | Master-registry document discriminator. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace authority receiving the operation. | |
request_id |
Yes | Reference: common.schema.json#/$defs/uuid | Client-generated correlation identifier. | |
operation |
Yes | "workspace.show", "doctor", "catalog.show", "jobs.start", "jobs.show", "jobs.cancel", "jobs.retry", "jobs.history", "artifacts.publish", "artifacts.show", "artifacts.verify", "artifacts.materialize", "artifacts.reconcile", "artifacts.abort", "artifacts.retire", "artifacts.lease-renew", "artifacts.lease-release", "artifacts.retain", "artifacts.release-reference", "artifacts.cache-prune", "media.import", "media.list", "media.show", "media.metadata", "media.raw", "media.refresh", "media.set-origin", "media.relocate", "models.register", "models.acquire", "models.list", "models.show", "models.verify", "models.materialize", "work.list", "work.show", "work.cancel", "work.retry", "credentials.select", "credentials.add", "credentials.replace", "credentials.delete", "credentials.status", "credentials.unlock", "credentials.load", "work.results", "recordings.process", "recordings.assemble", "recordings.show", "recordings.document", "recordings.mappings", "recordings.map-speaker", "recordings.export", "recordings.resolve-segment", "pipelines.list", "pipelines.show", "pipelines.set", "pipelines.inspect", "speakers.list", "speakers.show", "speakers.set", "speakers.aliases", "speakers.select", "speakers.diagnostics", "terms.list", "terms.show", "terms.set", "terms.compile", "settings.show", "settings.set", "recordings.cues", "media.playback", "media.playback-check", "media.playback-close", "media.capture", "graph.capabilities", "graph.status", "graph.publish", "graph.rebuild", "evidence.extract", "evidence.show", "query.run", "query.explain", "query.list", "query.show", "query.save", "query.validate", "timeline.calendar", "timeline.recording", "views.show", "views.save", "query.assist", "query.assistance-show", "query.assistance-set", "recordings.roster.show", "recordings.roster.add", "recordings.roster.remove", "recordings.roster.replace", "recordings.roster.clear", "models.resolve", "models.discover", "models.alias.list", "models.alias.show", "models.alias.set", "models.alias.remove", "models.source.list", "models.source.show", "models.source.set", "models.source.remove", "models.dataset.create", "models.dataset.list", "models.dataset.show", "models.train", "models.speaker.list", "models.speaker.show", "models.speaker.fetch", "models.profile.set", "recordings.match" | Shared operation selected by either client. | |
job_id |
No | Reference: common.schema.json#/$defs/uuid | Durable job identity to inspect, view history, cancel or retry. | |
after_generation |
No | integer | Exclusive attempt generation cursor for bounded job history pages. | |
duration_ms |
No | integer | Bounded qualification attempt duration in integer milliseconds. | |
publication_id |
No | Reference: common.schema.json#/$defs/uuid | Artifact publication identity scoped to this workspace. | |
lease_id |
No | Reference: common.schema.json#/$defs/uuid | Renewable materialization lease identity. | |
reference_id |
No | Reference: common.schema.json#/$defs/uuid | Durable retention reference identity. | |
source_path |
No | string | Explicit local source file streamed privately by the shared runtime. | |
artifact_kind |
No | string | Nonsecret artifact role recorded with its immutable content identity. | |
max_bytes |
No | integer | Explicit materialization byte ceiling overriding the default 10 GiB cache admission bound. | |
item_id |
No | Reference: common.schema.json#/$defs/uuid | Workspace-scoped media, model, work, pipeline, speaker or term identity. | |
data |
No | object | Operation-specific input; credential input is transient current-user IPC and is never journaled. |
All of the following constraints apply:
When the condition matches:
Disallowed combination: has after_generation.
When operation is "jobs.start":
Required fields: duration_ms.
Disallowed combination: has job_id.
When operation matches "jobs.show", "jobs.cancel", "jobs.retry", "jobs.history":
Required fields: job_id.
Disallowed combination: has duration_ms.
When operation matches "workspace.show", "doctor", "catalog.show":
Disallowed combination: the condition matches.
When operation matches "workspace.show", "doctor", "catalog.show", "jobs.start", "jobs.show", "jobs.cancel", "jobs.retry", "jobs.history":
Disallowed combination: the condition matches.
When operation matches "artifacts.publish":
Required fields: source_path, artifact_kind.
Disallowed combination: the condition matches.
When operation matches "artifacts.lease-renew", "artifacts.lease-release":
Required fields: publication_id, lease_id.
Disallowed combination: the condition matches.
When operation matches "artifacts.retain", "artifacts.release-reference":
Required fields: publication_id, reference_id.
Disallowed combination: the condition matches.
When operation matches "artifacts.show", "artifacts.verify", "artifacts.materialize", "artifacts.reconcile", "artifacts.abort", "artifacts.retire", "artifacts.cache-prune":
Required fields: publication_id.
Disallowed combination: the condition matches.
When operation matches Structured value:
Disallowed combination: has max_bytes.
When operation matches "workspace.show", "doctor", "catalog.show", "jobs.start", "jobs.show", "jobs.cancel", "jobs.retry", "jobs.history", "artifacts.publish", "artifacts.show", "artifacts.verify", "artifacts.materialize", "artifacts.reconcile", "artifacts.abort", "artifacts.retire", "artifacts.lease-renew", "artifacts.lease-release", "artifacts.retain", "artifacts.release-reference", "artifacts.cache-prune":
Disallowed combination: the condition matches.
When operation matches "media.import", "media.list", "media.show", "media.metadata", "media.raw", "media.refresh", "media.set-origin", "media.relocate", "models.register", "models.acquire", "models.list", "models.show", "models.verify", "models.materialize", "work.list", "work.show", "work.cancel", "work.retry", "credentials.select", "credentials.add", "credentials.replace", "credentials.delete", "credentials.status", "credentials.unlock", "credentials.load", "pipelines.list", "pipelines.show", "pipelines.set", "pipelines.inspect", "speakers.list", "speakers.show", "speakers.set", "speakers.aliases", "speakers.select", "speakers.diagnostics", "terms.list", "terms.show", "terms.set", "terms.compile", "models.resolve", "models.discover", "models.alias.list", "models.alias.show", "models.alias.set", "models.alias.remove", "models.source.list", "models.source.show", "models.source.set", "models.source.remove", "models.dataset.create", "models.dataset.list", "models.dataset.show", "models.train", "models.speaker.list", "models.speaker.show", "models.speaker.fetch", "models.profile.set", "recordings.match":
Disallowed combination: the condition matches.
When operation matches "media.list", "models.list", "work.list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded current-state list page. |
Disallowed combination: has item_id.
data
Bounded current-state list page.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive lexically ordered UUID cursor. | |
limit |
No | integer | Maximum entries, default100. |
When operation matches "media.show", "media.metadata", "media.raw", "models.show", "models.verify", "models.materialize", "work.show", "work.cancel", "work.retry":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation matches "media.import":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: import-manifest.schema.json | Batch media admission with inherited local_http, acquisition_max_bytes and acquisition_timeout_ms options. Credential transport is validated before durable work admission. |
Disallowed combination: the condition matches.
When operation matches "models.register", "models.acquire":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Typed input for the selected operation. |
Disallowed combination: the condition matches.
data
Typed input for the selected operation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest |
Yes | Reference: base-model-manifest.schema.json | Exact downloaded base-model identity and file contract. |
When operation matches "media.refresh":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: import-manifest.schema.json#/properties/defaults | Typed input for the selected operation. |
When operation matches "media.set-origin":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Typed input for the selected operation. |
data
Typed input for the selected operation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
Yes | integer | Current catalog revision for compare-and-swap. | |
options |
Yes | Reference: import-manifest.schema.json#/properties/defaults | Owner date and timezone selection. |
When operation matches "media.relocate":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Typed input for the selected operation. |
data
Typed input for the selected operation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
Yes | integer | Current catalog revision for compare-and-swap. | |
path |
Yes | string | New local reference path with unchanged digest and size. |
When operation matches "credentials.select", "credentials.add", "credentials.replace", "credentials.delete", "credentials.status", "credentials.unlock", "credentials.load":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Typed input for the selected operation. |
Disallowed combination: the condition matches.
data
Typed input for the selected operation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
arguments |
Yes | array | Credential operation and optional nonsecret identifier or backend. | |
input |
No | object | Bounded transient value/passphrase/session envelope from protected stdin. |
data.arguments
Credential operation and optional nonsecret identifier or backend.
Value: array.
data.arguments[]
Value: string.
data.input
Bounded transient value/passphrase/session envelope from protected stdin.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | At least one alternative | Credential value kept outside public contracts and journals. | |
passphrase |
No | string | Vault passphrase kept in current runtime memory. | |
session |
No | object | Explicit transient UUID-keyed credential mapping. |
data.input.value
Credential value kept outside public contracts and journals.
At least one of the following alternatives must match:
data.input.value: Alternative 1
Value: string.
data.input.value: Alternative 2
Value: object.
data.input.session
Explicit transient UUID-keyed credential mapping.
Value: object.
data.input.session{name}
At least one of the following alternatives must match:
data.input.session{name}: Alternative 1
Value: string.
data.input.session{name}: Alternative 2
Value: object.
When operation is "work.results":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded per-item result page. |
Disallowed combination: the condition matches.
data
Bounded per-item result page.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
after_ordinal |
No | integer | Inclusive first result ordinal, default0. | |
limit |
No | integer | Maximum entries, default100. |
When operation matches "recordings.process", "recordings.assemble", "recordings.show", "recordings.document", "recordings.mappings", "recordings.map-speaker", "recordings.export", "recordings.resolve-segment", "recordings.roster.show", "recordings.roster.add", "recordings.roster.remove", "recordings.roster.replace", "recordings.roster.clear":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation is "recordings.process":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Explicit direct or saved-pipeline processing elections, with source and current-recording compatibility checked by the runtime. |
data
Explicit direct or saved-pipeline processing elections, with source and current-recording compatibility checked by the runtime.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
transcription |
No | "supplied", "generate", "reuse" | Use supplied native subtitles, generate with a managed recognition model, or reuse the current native document. | |
diarization |
No | "run", "reuse" | Run managed local diarization or reuse current assignment evidence. | |
recognition_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
diarization_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Shared model reference; submission freezes an exact compatible target before acquisition and processing. | |
subtitle_format |
No | "srt", "vtt" | Native supplied subtitle format. | |
audio |
No | object | Selected original audio stream and channel before mono 16 kHz mapping. | |
recognition |
No | object | Local recognition execution parameters. | |
attribution |
No | object | Local diarization execution parameters. | |
pipeline_id |
No | Reference: common.schema.json#/$defs/uuid | Id. | |
pipeline_revision |
No | Reference: common.schema.json#/$defs/revision | Revision. | |
overrides |
No | Reference: pipeline-config.schema.json#/$defs/overrides | Overrides. | |
context |
No | object | Explicit speaker, language and context filters for deterministic recognition hints. | |
quality |
No | Reference: pipeline-config.schema.json#/$defs/quality | Direct managed-worker quality policy; saved pipeline runs use explicit quality overrides instead. |
data.audio
Selected original audio stream and channel before mono 16 kHz mapping.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
stream_index |
No | integer | Absolute source stream index. | |
channel |
No | integer | Zero-based source channel; omission downmixes to mono. |
data.recognition
Local recognition execution parameters.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
device |
No | "cpu", "cuda" | Explicit device; default CPU and no provider fallback. | |
language |
No | string | Language code or automatic detection; default en. |
data.attribution
Local diarization execution parameters.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
device |
No | "cpu", "cuda" | Explicit device; default CPU with no fallback from selected CUDA. | |
min_speakers |
No | integer | Optional lower acoustic speaker-count constraint. | |
max_speakers |
No | integer | Optional upper acoustic speaker-count constraint. | |
quality |
No | Reference: pipeline-config.schema.json#/$defs/quality | Optional direct diarization quality policy. |
data.context
Explicit speaker, language and context filters for deterministic recognition hints.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speaker_ids |
No | array | Speaker ids. | |
language |
No | string | Language. | |
context |
No | string | Context. |
data.context.speaker_ids
Speaker ids.
Value: array.
data.context.speaker_ids[]
Id.
Value: Reference: common.schema.json#/$defs/uuid.
All of the following constraints apply:
When the condition matches:
Required fields: recognition_model_id.
When the condition matches:
Required fields: diarization_model_id.
data: Alternative 3
Disallowed combination: transcription is "reuse" and diarization is "reuse".
When overrides matches object:
Required fields: pipeline_id.
When operation is "recordings.assemble":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Transient native-subtitle assembly input; never an alternate stored transcript. |
data
Transient native-subtitle assembly input; never an alternate stored transcript.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
subtitle_format |
No | "srt", "vtt" | Imported native subtitle format. | |
turns |
Yes | array | Source-clock acoustic evidence. | |
participation |
No | array | Explicit associations for unresolved cues. |
data.turns
Source-clock acoustic evidence.
Value: array.
data.turns[]
Ephemeral source-clock acoustic interval.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
label |
Yes | string | Operation-local acoustic voice label. | |
start_us |
Yes | integer | Inclusive source-clock microsecond start. | |
end_us |
Yes | integer | Exclusive source-clock microsecond end. |
data.participation
Explicit associations for unresolved cues.
Value: array.
data.participation[]
Explicit cue-to-voice association supplied by the caller.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
cue_id |
Yes | string | Native cue identity. | |
label |
Yes | string | Operation-local acoustic voice label. |
When operation is "recordings.show":
Disallowed combination: has data.
When operation is "recordings.document":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Digest-bound bounded page of the current native document. |
data
Digest-bound bounded page of the current native document.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
offset |
No | integer | Zero-based byte offset. | |
limit |
No | integer | Maximum returned bytes, default 65536. | |
document_digest |
No | Reference: common.schema.json#/$defs/sha256 | Optional expected current document digest. |
When operation is "recordings.mappings":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded current speaker-mapping page. |
data
Bounded current speaker-mapping page.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive local speaker identity cursor. | |
limit |
No | integer | Maximum mapping rows, default 100. |
When operation is "recordings.map-speaker":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Compare-and-set external known-speaker mapping. |
data
Compare-and-set external known-speaker mapping.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
Yes | integer | Expected current mapping revision; zero creates the mapping. | |
local_speaker_id |
Yes | Reference: common.schema.json#/$defs/localSpeakerID | Current Cueson-local speaker identity. | |
mapping_revision |
No | integer | Expected existing mapping revision for correction; omitted or zero creates a new mapping. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Known catalog speaker identity. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected current native document digest. |
When operation is "recordings.export":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Explicit current-document export. |
data
Explicit current-document export.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
format |
Yes | "cueson", "srt", "vtt" | Native Cueson or flattened subtitle export. | |
strict |
No | boolean | Reject conversion that loses timing or attribution. | |
destination |
Yes | string | Absolute selected output path; existing-file replacement follows runtime authorization. | |
document_digest |
No | Reference: common.schema.json#/$defs/sha256 | Optional expected current native document digest. |
When operation is "recordings.resolve-segment":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Resolve an existing source segment against the current recording revision. |
data
Resolve an existing source segment against the current recording revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
segment_id |
Yes | Reference: common.schema.json#/$defs/uuid | Existing source-segment identity. | |
segment_revision |
Yes | integer | Expected source-segment revision. |
When operation matches "pipelines.list", "speakers.list", "terms.list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded stable entity list page, using an exclusive after_id cursor. |
Disallowed combination: has item_id.
data
Bounded stable entity list page, using an exclusive after_id cursor.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
No | integer | Limit. | |
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive last entity ID from the prior page. |
When operation matches "pipelines.show", "speakers.show", "terms.show":
Required fields: item_id.
Disallowed combination: has data.
When operation matches "pipelines.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Operation-specific bounded configuration. |
data
Operation-specific bounded configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected revision. | |
pipeline |
Yes | Reference: pipeline-config.schema.json#/$defs/entity | Pipeline. |
When operation matches "speakers.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Operation-specific bounded configuration. |
data
Operation-specific bounded configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected revision. | |
speaker |
Yes | object | Canonical stable speaker identity; shared names never imply identity equivalence. | |
aliases |
Yes | array | Aliases. |
data.speaker
Canonical stable speaker identity; shared names never imply identity equivalence.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
name |
Yes | string | Name. | |
revision |
No | integer | Revision. | |
state |
No | "active", "inactive" | State. |
data.aliases
Aliases.
Value: array.
data.aliases[]
Alternate speaker spelling scoped to its stable speaker. Aggregate speaker revision controls replacement.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
text |
Yes | string | Text. | |
language |
No | string | Language. | |
scope |
No | string | Scope. | |
state |
No | "active", "inactive" | State. | |
provenance |
No | object | Provenance. |
When operation matches "terms.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Operation-specific bounded configuration. |
data
Operation-specific bounded configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected revision. | |
term |
Yes | object | Stable revisioned terminology entry with optional speaker or alias linkage. |
data.term
Stable revisioned terminology entry with optional speaker or alias linkage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
revision |
No | integer | Revision. | |
canonical |
Yes | string | Canonical. | |
variants |
No | array | Variants. | |
language |
No | string | Language. | |
context |
No | string | Context. | |
state |
No | "active", "inactive" | State. | |
speaker_id |
No | At least one alternative | Speaker id. | |
alias_id |
No | At least one alternative | Alias id. | |
provenance |
No | object | Provenance. |
data.term.variants
Variants.
Value: array.
data.term.variants[]
Value: string.
data.term.speaker_id
Speaker id.
At least one of the following alternatives must match:
data.term.speaker_id: Alternative 1
Id.
Value: Reference: common.schema.json#/$defs/uuid.
data.term.speaker_id: Alternative 2
Value: null.
data.term.alias_id
Alias id.
At least one of the following alternatives must match:
data.term.alias_id: Alternative 1
Id.
Value: Reference: common.schema.json#/$defs/uuid.
data.term.alias_id: Alternative 2
Value: null.
When operation matches "pipelines.inspect":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Inspect a saved or explicitly overridden pipeline without probing or running workers. |
data
Inspect a saved or explicitly overridden pipeline without probing or running workers.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
No | Reference: common.schema.json#/$defs/revision | Revision. | |
overrides |
No | Reference: pipeline-config.schema.json#/$defs/overrides | Overrides. | |
context |
No | object | Explicit speaker, language and context filters for deterministic recognition hints. |
data.context
Explicit speaker, language and context filters for deterministic recognition hints.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speaker_ids |
No | array | Speaker ids. | |
language |
No | string | Language. | |
context |
No | string | Context. |
data.context.speaker_ids
Speaker ids.
Value: array.
data.context.speaker_ids[]
Id.
Value: Reference: common.schema.json#/$defs/uuid.
When operation matches "speakers.aliases":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Operation-specific bounded configuration. |
data
Operation-specific bounded configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected revision. | |
aliases |
Yes | array | Aliases. |
data.aliases
Aliases.
Value: array.
data.aliases[]
Alternate speaker spelling scoped to its stable speaker. Aggregate speaker revision controls replacement.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Id. | |
text |
Yes | string | Text. | |
language |
No | string | Language. | |
scope |
No | string | Scope. | |
state |
No | "active", "inactive" | State. | |
provenance |
No | object | Provenance. |
When operation matches "speakers.select":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded current speaker evidence selection, optionally limited to one recording. |
data
Bounded current speaker evidence selection, optionally limited to one recording.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
cursor |
No | string | Cursor. | |
limit |
No | integer | Limit. | |
recording_id |
No | Reference: common.schema.json#/$defs/uuid | Id. | |
quality |
No | Reference: #/$defs/correlationQuality | Optional diagnostic setting returned explicitly as the effective quality policy. |
When operation matches "speakers.diagnostics":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded current speaker evidence selection, optionally limited to one recording. |
data
Bounded current speaker evidence selection, optionally limited to one recording.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
cursor |
No | string | Cursor. | |
limit |
No | integer | Limit. | |
recording_id |
No | Reference: common.schema.json#/$defs/uuid | Id. | |
quality |
No | Reference: #/$defs/correlationQuality | Optional diagnostic setting returned explicitly as the effective quality policy. |
When operation matches "terms.compile":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Compile scoped recognition hints without inference. Omitted standalone budget is 200 UTF-8 bytes; a selected pipeline contributes its declared capability budget. |
Disallowed combination: has item_id.
data
Compile scoped recognition hints without inference. Omitted standalone budget is 200 UTF-8 bytes; a selected pipeline contributes its declared capability budget.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
pipeline_id |
No | Reference: common.schema.json#/$defs/uuid | Id. | |
pipeline_revision |
No | Reference: common.schema.json#/$defs/revision | Revision. | |
speaker_ids |
No | array | Speaker ids. | |
language |
No | string | Language. | |
context |
No | string | Context. | |
max_hint_bytes |
No | integer | Max hint bytes. |
data.speaker_ids
Speaker ids.
Value: array.
data.speaker_ids[]
Id.
Value: Reference: common.schema.json#/$defs/uuid.
When operation matches "settings.show", "settings.set", "recordings.cues", "media.playback", "media.playback-check", "media.playback-close":
Disallowed combination: the condition matches.
When operation matches "settings.show":
Disallowed combination: the condition matches.
When operation matches "settings.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | One validated configuration section changed with independent compare-and-swap revision. |
Disallowed combination: has item_id.
data
One validated configuration section changed with independent compare-and-swap revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
section |
Yes | "media_tools", "processing_tools", "appearance" | Selected runtime configuration section. | |
revision |
Yes | string | Exact lowercase SHA-256 digest or opaque current section revision. | |
value |
Yes | object or null | Validated explicit section value, or null to remove the workspace override with compare-and-swap and elect current defaults. |
All of the following constraints apply:
When section is "media_tools":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | At least one alternative | Validated pinned metadata extraction tool configuration, or null to reset the override without persisting installation paths. |
value
Validated pinned metadata extraction tool configuration, or null to reset the override without persisting installation paths.
At least one of the following alternatives must match:
value: Alternative 1
Value: Reference: media-tools.schema.json.
value: Alternative 2
Value: null.
When section is "processing_tools":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | At least one alternative | Validated pinned subtitle and processing tool configuration, or null to reset the override and use current installed companions. |
value
Validated pinned subtitle and processing tool configuration, or null to reset the override and use current installed companions.
At least one of the following alternatives must match:
value: Alternative 1
Value: Reference: processing-tools.schema.json.
value: Alternative 2
Value: null.
When section is "appearance":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | object or null | Persisted accessible display preferences, or null to remove the override and use system appearance defaults. |
value
Persisted accessible display preferences, or null to remove the override and use system appearance defaults.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
theme |
Yes | "system", "light", "dark" | Preferred display palette. | |
reduced_motion |
Yes | boolean | Request reduced interface motion. |
When operation matches "recordings.cues":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded semantic current cue page with optional expected authority. |
data
Bounded semantic current cue page with optional expected authority.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
No | integer | Expected current recording revision. | |
document_digest |
No | string | Exact lowercase SHA-256 digest or opaque current section revision. | |
after_ordinal |
No | integer | Inclusive zero-based first cue ordinal. | |
limit |
No | integer | Maximum projected cues in one bounded response. |
When operation matches "media.playback":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Authorize verified current source bytes and optional current recording evidence. |
data
Authorize verified current source bytes and optional current recording evidence.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
Yes | integer | Expected current media revision. | |
recording_revision |
No | integer | Expected current recording revision when selecting evidence. | |
document_digest |
No | string | Exact lowercase SHA-256 digest or opaque current section revision. | |
max_bytes |
No | integer | Maximum source snapshot bytes. | |
stream_index |
No | integer | Absolute canonical audio stream index for selected-track playback. |
When operation matches "media.playback-check", "media.playback-close":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Touch or close one runtime-owned playback handle. |
data
Touch or close one runtime-owned playback handle.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
playback_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace-scoped current handle identity. |
When operation is "media.capture":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Exact current stored metadata, facts or date JSON bytes for lossless text display. |
Disallowed combination: the condition matches.
data
Exact current stored metadata, facts or date JSON bytes for lossless text display.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
section |
Yes | "metadata", "facts", "dates" | Current stored capture section. | |
revision |
No | integer | Expected current media revision. | |
sha256 |
No | string | Expected exact capture byte digest for subsequent pages. | |
offset |
No | integer | Inclusive first byte offset. | |
limit |
No | integer | Maximum bytes in one response. |
When operation is "graph.capabilities":
Disallowed combination: the condition matches.
When operation is "graph.status":
Disallowed combination: the condition matches.
When operation is "graph.publish":
Disallowed combination: the condition matches.
When operation is "graph.rebuild":
Disallowed combination: the condition matches.
When operation is "evidence.extract":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Validated shared exploration input. |
Disallowed combination: the condition matches.
data
Validated shared exploration input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected current revision, or zero when creating. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Exact current Cue JSON digest. | |
configuration |
Yes | object | Maintainer-elected extraction route and bounded context. No inference is elected by required CI. |
data.configuration
Maintainer-elected extraction route and bounded context. No inference is elected by required CI.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
No | "cue-statement", "http" | Literal source-reference extraction, or elected HTTP assertion adapter. | |
contract_version |
No | Constant "1" | Assertion adapter protocol version. | |
endpoint |
No | string | Elected HTTP endpoint without URL credentials. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Stable catalog identity. | |
model |
No | string | Elected adapter model. | |
window_cues |
No | integer | Maximum complete cues per context window. | |
overlap_cues |
No | integer | Complete cue overlap between context windows. | |
max_chunk_bytes |
No | integer | Bounded serialized context size. | |
timeout_ms |
No | integer | Maximum time per HTTP context. | |
max_response_bytes |
No | integer | Bounded HTTP result size. |
When operation is "evidence.show":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation is "query.run":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Exactly one alternative | Definition or saved-query selection. |
Disallowed combination: the condition matches.
data
Definition or saved-query selection.
Exactly one of the following alternatives must match:
data: Alternative 1
Execute a supplied current query definition.
Value: Reference: #/$defs/exploreQuery.
data: Alternative 2
Execute an immutable saved definition against current sources.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
saved_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable catalog identity. | |
revision |
No | integer | Expected current revision, or zero when creating. |
When operation is "query.explain":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Exactly one alternative | Definition or saved-query selection. |
Disallowed combination: the condition matches.
data
Definition or saved-query selection.
Exactly one of the following alternatives must match:
data: Alternative 1
Execute a supplied current query definition.
Value: Reference: #/$defs/exploreQuery.
data: Alternative 2
Execute an immutable saved definition against current sources.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
saved_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable catalog identity. | |
revision |
No | integer | Expected current revision, or zero when creating. |
When operation is "query.list":
Disallowed combination: the condition matches.
When operation is "query.show":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Optional immutable version selection. |
Disallowed combination: the condition matches.
data
Optional immutable version selection.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
revision |
No | integer | Expected current revision, or zero when creating. |
When operation is "query.save":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Validated shared exploration input. |
Disallowed combination: the condition matches.
data
Validated shared exploration input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected current revision, or zero when creating. | |
query |
Yes | Reference: #/$defs/exploreQuery | New immutable definition. |
When operation is "query.validate":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Exactly one alternative | Definition or saved-query selection. |
Disallowed combination: the condition matches.
data
Definition or saved-query selection.
Exactly one of the following alternatives must match:
data: Alternative 1
Execute a supplied current query definition.
Value: Reference: #/$defs/exploreQuery.
data: Alternative 2
Execute an immutable saved definition against current sources.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
saved_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable catalog identity. | |
revision |
No | integer | Expected current revision, or zero when creating. |
When operation is "timeline.calendar":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Calendar viewport over the whole library. |
Disallowed combination: the condition matches.
data
Calendar viewport over the whole library.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
filter |
Yes | object | Origination calendar filter preserving timezone and undated handling. | |
pagination |
No | object | Bounded current-result pagination. |
data.filter
Origination calendar filter preserving timezone and undated handling.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
from |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive first recording date. | |
through |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive last recording date. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Calendar timezone for this filter. | |
include_undated |
No | boolean | Explicitly include entries with unknown recording dates. |
data.pagination
Bounded current-result pagination.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Maximum number of returned rows. | |
cursor |
No | string | Opaque current-result continuation cursor. |
When operation is "timeline.recording":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Current source-clock cues, assertions and mapped segments. |
Disallowed combination: the condition matches.
data
Current source-clock cues, assertions and mapped segments.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
pagination |
No | object | Bounded current-result pagination. |
data.pagination
Bounded current-result pagination.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Maximum number of returned rows. | |
cursor |
No | string | Opaque current-result continuation cursor. |
When operation is "views.show":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation is "views.save":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Validated shared exploration input. |
Disallowed combination: the condition matches.
data
Validated shared exploration input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Expected current revision, or zero when creating. | |
query_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable catalog identity. | |
layout |
Yes | object | Presentation state stored separately from graph facts. |
data.layout
Presentation state stored separately from graph facts.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
positions |
No | object | Stable graph node IDs mapped to positions. | |
paused |
No | boolean | Pause force simulation. | |
filter |
No | string | Presentation label filter. | |
limit |
No | integer | Visible node bound. |
data.layout.positions
Stable graph node IDs mapped to positions.
Value: object.
data.layout.positions{name}
One stable graph-node position.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
x |
Yes | number | Horizontal display position. | |
y |
Yes | number | Vertical display position. |
When operation is "query.assist":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: query-assistance.schema.json#/$defs/request | Strict assistance input. |
Disallowed combination: the condition matches.
When operation is "query.assistance-show":
Disallowed combination: the condition matches.
When operation is "query.assistance-set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: query-assistance.schema.json#/$defs/setting | Strict assistance input. |
Disallowed combination: the condition matches.
When operation is "recordings.roster.show":
Disallowed combination: has data.
When operation matches "recordings.roster.add", "recordings.roster.remove", "recordings.roster.replace", "recordings.roster.clear":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revision-fenced declared roster mutation; membership is independent of acoustic assignments. |
data
Revision-fenced declared roster mutation; membership is independent of acoustic assignments.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Observed independent roster revision, zero only when no header exists. | |
speakers |
Yes | array | Speaker references by UUID, exact canonical name or unique active alias. |
data.speakers
Speaker references by UUID, exact canonical name or unique active alias.
Value: array.
data.speakers[]
Value: string.
When operation matches "recordings.roster.add", "recordings.roster.remove":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Nonempty membership edit input. |
data
Nonempty membership edit input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speakers |
No | array | One or more speaker references for add or remove. |
When operation matches "models.resolve":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Reference inspection input. |
Disallowed combination: the condition matches.
data
Reference inspection input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
reference |
Yes | Reference: common.schema.json#/$defs/modelReference | Reference to resolve without acquiring files. | |
operation |
Yes | Reference: common.schema.json#/$defs/modelOperation | Intended consumer operation. |
When operation matches "models.discover":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Bounded source metadata discovery. |
Disallowed combination: the condition matches.
data
Bounded source metadata discovery.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
source_id |
Yes | Reference: common.schema.json#/$defs/uuid | Explicit configured source identity. |
When operation matches "models.alias.list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded reference inventory page. |
Disallowed combination: the condition matches.
data
Bounded reference inventory page.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive stable identity page cursor. | |
limit |
No | integer | Maximum records in this page. |
When operation matches "models.alias.show":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation matches "models.alias.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revision-fenced explicit reference mutation. |
data
Revision-fenced explicit reference mutation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Zero creates; a positive exact revision fences retargeting. | |
alias |
Yes | object | Portable revisioned alias retaining exact target kind and identity. |
data.alias
Portable revisioned alias retaining exact target kind and identity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable workspace-scoped alias identity. | |
name |
Yes | Reference: common.schema.json#/$defs/modelAliasName | Short workspace name. | |
revision |
No | Constant 0 | Optional zero-valued typed input; accepted revisions are returned by the catalog, never supplied as a new record revision. | |
state |
Yes | "active", "deleted" | Active reference or retained revision tombstone. | |
target |
Yes | Reference: common.schema.json#/$defs/modelTarget | Exact target; retargeting never changes prior elections. |
When operation matches "models.alias.remove":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revision-fenced reference removal. |
data
Revision-fenced reference removal.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Exact revision to remove while preserving the tombstone. |
When operation matches "models.source.list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded reference inventory page. |
Disallowed combination: the condition matches.
data
Bounded reference inventory page.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive stable identity page cursor. | |
limit |
No | integer | Maximum records in this page. |
When operation matches "models.source.show":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation matches "models.source.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revision-fenced explicit reference mutation. |
data
Revision-fenced explicit reference mutation.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Zero creates; a positive exact revision fences retargeting. | |
source |
Yes | object | Portable source configuration without credential values. |
data.source
Portable source configuration without credential values.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable configured source identity. | |
name |
Yes | Reference: common.schema.json#/$defs/modelAliasName | Configured source name used by source:NAME/SELECTOR. | |
revision |
No | Constant 0 | Optional zero-valued typed input; accepted revisions are returned by the catalog, never supplied as a new record revision. | |
state |
Yes | "active", "deleted" | Active configuration or retained revision tombstone. | |
url |
Yes | string | Configured catalog URL using HTTPS or explicitly elected loopback HTTP. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Opaque source credential reference. | |
local_http |
No | boolean | Permit HTTP only for an explicitly selected loopback catalog. |
When operation matches "models.source.remove":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revision-fenced reference removal. |
data
Revision-fenced reference removal.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Exact revision to remove while preserving the tombstone. |
When operation matches "models.dataset.create":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Create complete current speaker dataset. |
Disallowed combination: the condition matches.
data
Create complete current speaker dataset.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Originating centralized speaker. | |
recipe |
No | Reference: #/$defs/speakerRecipe | Optional effective corpus selection. |
When operation matches "models.dataset.list", "models.speaker.list":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
No | object | Bounded speaker dataset/model inventory. |
Disallowed combination: the condition matches.
data
Bounded speaker dataset/model inventory.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
speaker_id |
No | Reference: common.schema.json#/$defs/uuid | Optional speaker lineage filter. | |
after_id |
No | Reference: common.schema.json#/$defs/uuid | Exclusive stable record cursor. | |
limit |
No | integer | Maximum rows returned. |
When operation matches "models.dataset.show", "models.speaker.show":
Required fields: item_id.
Disallowed combination: the condition matches.
When operation matches "models.train":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: #/$defs/speakerTrain | Durable elected training request. |
Disallowed combination: the condition matches.
When operation matches "models.speaker.fetch":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Exact version retrieval. |
data
Exact version retrieval.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
destination |
Yes | string | Explicit output destination directory. |
When operation matches "models.profile.set":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | object | Revisioned current speaker profile selection. |
data
Revisioned current speaker profile selection.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
expected_revision |
Yes | integer | Zero creates; positive exact revision updates or clears. | |
version_id |
Yes | string | Exact output version; empty clears current profile. |
When operation matches "recordings.match":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
data |
Yes | Reference: #/$defs/speakerMatch | Elected current voice identity matching. |
Definition: correlationQuality
Optional current-speaker correlation diagnostics policy. Evidence validation, source timing resolution and deduplication remain mandatory.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
enabled |
No | boolean | Emit optional correlation diagnostics; omission defaults to true. |
Definition: exploreQuery
Typed normalized or declared-native query definition.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
title |
No | string | Human-readable query title. | |
definition |
Yes | Exactly one alternative | Exactly one normalized application specification or native dialect/text definition. | |
parameters |
No | object | Named typed parameters, passed as values rather than interpolated query text. |
Definition: exploreQuery.definition
Exactly one normalized application specification or native dialect/text definition.
Exactly one of the following alternatives must match:
Definition: exploreQuery.definition: normalized
Portable application QuerySpec compiled separately by each official graph adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
Yes | Constant "normalized" | Selects backend-neutral application operations. | |
operation |
Yes | "media-list", "speaker-search", "model-list", "text-search", "time-range", "evidence-traverse", "graph-view" | Supported normalized operation with identical intended results on LadybugDB and ArcadeDB. | |
filters |
No | object | Portable application filters. Unknown filters are rejected instead of ignored. | |
traversal |
No | object | Explicit bounded graph expansion, without an engine-specific query string. | |
order_by |
No | array | Deterministic ordering, with a stable entity-ID tie breaker added by the application if needed. | |
pagination |
No | object | Bounded current-result pagination. |
Definition: exploreQuery.definition: normalized.filters
Portable application filters. Unknown filters are rejected instead of ignored.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
media_ids |
No | array | Restrict to explicit media entries. | |
speaker_ids |
No | array | Current speaker/lineage filter. | |
text |
No | string | Text/term search phrase, interpreted by the selected normalized operation. | |
model_kind |
No | string | Declared trained-model kind filter. | |
recording_dates |
No | object | Origination calendar filter preserving timezone and undated handling. | |
source_interval |
No | Reference: common.schema.json#/$defs/mediaInterval | Original-clock interval filter; application checks source ownership and bounds. | |
concept_ids |
No | array | Concept filter for evidence/graph traversal. | |
entity_ids |
No | array | Stable projected graph node references used as bounded traversal seeds. |
Definition: exploreQuery.definition: normalized.filters.media_ids
Restrict to explicit media entries.
Value: array.
Definition: exploreQuery.definition: normalized.filters.media_ids[]
Selected library media entry ID.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: exploreQuery.definition: normalized.filters.speaker_ids
Current speaker/lineage filter.
Value: array.
Definition: exploreQuery.definition: normalized.filters.speaker_ids[]
Selected catalog speaker ID.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: exploreQuery.definition: normalized.filters.recording_dates
Origination calendar filter preserving timezone and undated handling.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
from |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive first recording date. | |
through |
No | Reference: common.schema.json#/$defs/calendarDate | Inclusive last recording date. | |
timezone |
No | Reference: common.schema.json#/$defs/timezone | Calendar timezone for this filter. | |
include_undated |
No | boolean | Explicitly include entries with unknown recording dates. |
Definition: exploreQuery.definition: normalized.filters.concept_ids
Concept filter for evidence/graph traversal.
Value: array.
Definition: exploreQuery.definition: normalized.filters.concept_ids[]
Normalized concept ID.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: exploreQuery.definition: normalized.filters.entity_ids
Stable projected graph node references used as bounded traversal seeds.
Value: array.
Definition: exploreQuery.definition: normalized.filters.entity_ids[]
Current projected graph node ID.
Value: string.
Definition: exploreQuery.definition: normalized.traversal
Explicit bounded graph expansion, without an engine-specific query string.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
relationship_types |
No | array | Relationship types included in expansion. | |
direction |
Yes | "out", "in", "both" | Direction of selected relationships. | |
max_depth |
Yes | integer | Positive explicit traversal depth; application capacity policies remain visible. |
Definition: exploreQuery.definition: normalized.traversal.relationship_types
Relationship types included in expansion.
Value: array.
Definition: exploreQuery.definition: normalized.traversal.relationship_types[]
Logical relationship type from the versioned projection schema.
Value: string.
Definition: exploreQuery.definition: normalized.order_by
Deterministic ordering, with a stable entity-ID tie breaker added by the application if needed.
Value: array.
Definition: exploreQuery.definition: normalized.order_by[]
One ordered result field.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
field |
Yes | "id", "title", "recording_date", "source_start_us", "speaker_name", "relevance", "media.originated_at", "media.id", "speaker.id", "model.id", "cue.start_us", "score" | Normalized field available to the selected operation. | |
direction |
Yes | "asc", "desc" | Sort direction. |
Definition: exploreQuery.definition: normalized.pagination
Bounded current-result pagination.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Maximum number of returned rows. | |
cursor |
No | string | Opaque current-result continuation cursor. |
Definition: exploreQuery.definition: native
Advanced query text with a declared dialect; arbitrary native text is not automatically portable.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
mode |
Yes | Constant "native" | Selects a declared native query dialect. | |
dialect |
Yes | string | Official native dialect or explicitly namespaced unofficial community dialect. | |
text |
Yes | string | Native query text. Read-only or maintenance operation mode is enforced by the adapter and configured privileges. |
Definition: exploreQuery.definition: native.dialect
Official native dialect or explicitly namespaced unofficial community dialect.
Value: string.
At least one of the following alternatives must match:
Definition: exploreQuery.definition: native.dialect: Alternative 1
Value: "ladybug-cypher", "arcade-opencypher", "arcade-sql".
Definition: exploreQuery.definition: native.dialect: Alternative 2
Value: string.
Definition: exploreQuery.parameters
Named typed parameters, passed as values rather than interpolated query text.
Value: object.
Definition: exploreQuery.parameters{name}
Typed native-query parameter normalized by the selected adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
type |
Yes | "string", "integer", "number", "boolean", "uuid", "date-time", "date", "array", "object", "null" | Logical parameter type, independent of backend value wrappers. | |
value |
Yes | At least one alternative | Parameter value matching its declared logical type; native adapters validate any narrower backend constraints. |
Definition: exploreQuery.parameters{name}.value
Parameter value matching its declared logical type; native adapters validate any narrower backend constraints.
At least one of the following alternatives must match:
Definition: exploreQuery.parameters{name}.value: Alternative 1
Value: string.
Definition: exploreQuery.parameters{name}.value: Alternative 2
Value: number.
Definition: exploreQuery.parameters{name}.value: Alternative 3
Value: boolean.
Definition: exploreQuery.parameters{name}.value: Alternative 4
Value: null.
Definition: exploreQuery.parameters{name}.value: Alternative 5
Value: array.
Definition: exploreQuery.parameters{name}.value: Alternative 6
Value: object.
All of the following constraints apply:
When type is "string":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | string | Value with the declared string JSON type. |
When type is "integer":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Exactly one alternative | Exact signed 64-bit integer as a JSON integer or canonical decimal string; the runtime enforces range. |
value
Exact signed 64-bit integer as a JSON integer or canonical decimal string; the runtime enforces range.
Exactly one of the following alternatives must match:
value: Alternative 1
Value: integer.
value: Alternative 2
Value: string.
When type is "number":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | number | Value with the declared number JSON type. |
When type is "boolean":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | boolean | Value with the declared boolean JSON type. |
When type is "uuid":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/uuid | UUID parameter value. |
When type is "date-time":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/utcInstant | UTC instant parameter value. |
When type is "date":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | Reference: common.schema.json#/$defs/calendarDate | Date-only parameter value. |
When type is "array":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | array | Value with the declared array JSON type. |
When type is "object":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | object | Value with the declared object JSON type. |
When type is "null":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
value |
No | null | Value with the declared null JSON type. |
Definition: explorePage
Bounded current-result pagination.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limit |
Yes | integer | Maximum number of returned rows. | |
cursor |
No | string | Opaque current-result continuation cursor. |
Definition: speakerPinnedFile
Hash-pinned local adapter file.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Exact absolute selected executable or support file path. | |
sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected selected file content digest. |
Definition: speakerLimits
Explicit bounded speaker adapter budgets.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
max_input_bytes |
No | integer | Maximum prepared input bytes. | |
max_output_bytes |
No | integer | Maximum adapter output bytes. | |
timeout_ms |
No | integer | Adapter execution deadline in milliseconds. |
Definition: speakerAdapter
Elected local, hosted or offline embedding speaker adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | "insonic-speaker", "pyannote-profile" | Implemented elected generic training or pinned offline profile adapter. | |
contract_version |
Yes | "1" | Implemented speaker adapter wire version. | |
mode |
Yes | "local", "hosted" | Explicit local or hosted route. | |
architecture |
Yes | string | Declared output architecture. | |
output_kinds |
Yes | array | Output kinds emitted by this adapter. | |
consumers |
Yes | array | Compatible consumer adapter identities. | |
needs_text |
No | boolean | Whether selected current transcript text is required transient input. | |
supports_resume |
No | boolean | Whether this exact adapter supports declared checkpoint resume. | |
executable |
No | Reference: #/$defs/speakerPinnedFile | Pinned local training executable. | |
arguments |
No | array | Explicit local arguments. | |
support_files |
No | array | Required pinned support files. | |
endpoint |
No | string | Explicit hosted HTTPS or loopback HTTP route. | |
remote_model |
No | string | Exact hosted model identity. | |
upstream_revision |
No | string | Immutable upstream identity. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Encrypted credential reference, never credential bytes. | |
license |
No | string | Adapter or output license declaration. | |
limits |
No | Reference: #/$defs/speakerLimits | Input/output/time limits. | |
supported_operations |
No | array | Operations the elected training adapter can declare for its output. | |
supports_cancel |
No | boolean | Whether the selected hosted contract implements cancellation of this exact work attempt. |
Definition: speakerAdapter.output_kinds
Output kinds emitted by this adapter.
Value: array.
Definition: speakerAdapter.output_kinds[]
Declared supported output kind.
Value: string.
Definition: speakerAdapter.consumers
Compatible consumer adapter identities.
Value: array.
Definition: speakerAdapter.consumers[]
Declared compatible consumer.
Value: string.
Definition: speakerAdapter.arguments
Explicit local arguments.
Value: array.
Definition: speakerAdapter.arguments[]
Literal selected noninteractive argument.
Value: string.
Definition: speakerAdapter.support_files
Required pinned support files.
Value: array.
Definition: speakerAdapter.support_files[]
Pinned local dependency file.
Value: Reference: #/$defs/speakerPinnedFile.
Definition: speakerAdapter.supported_operations
Operations the elected training adapter can declare for its output.
Value: array.
Definition: speakerAdapter.supported_operations[]
Value: string.
All of the following constraints apply:
When mode matches "hosted":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
limits |
No | object | Hosted JSON transport memory limits. |
Disallowed combination: the condition matches.
limits
Hosted JSON transport memory limits.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
max_input_bytes |
No | integer | Maximum hosted media bytes buffered by this JSON transport. | |
max_output_bytes |
No | integer | Maximum hosted JSON response bytes. |
Otherwise:
Disallowed combination: the condition matches.
Definition: speakerRecipe
Current independently attributed corpus selection recipe.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recording_id |
No | Reference: common.schema.json#/$defs/uuid | Optional exact recording corpus filter. | |
min_duration_us |
No | integer | Minimum included source interval duration. | |
max_duration_us |
No | integer | Maximum included source interval duration. | |
exclude_overlap |
No | boolean | Exclude overlapping current voice evidence. | |
recording_ids |
No | array | Optional recording allowlist. | |
languages |
No | array | Optional language allowlist. | |
channel |
No | integer | Zero-based selected source audio channel. | |
excluded_references |
No | array | Explicit current-reference exclusions. | |
min_rms |
No | number | Minimum normalized decoded root mean square amplitude. | |
max_clipping_fraction |
No | number | Maximum fraction of decoded full-scale samples. |
Definition: speakerRecipe.recording_ids
Optional recording allowlist.
Value: array.
Definition: speakerRecipe.recording_ids[]
Selected exact recording identity.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: speakerRecipe.languages
Optional language allowlist.
Value: array.
Definition: speakerRecipe.languages[]
Current cue language selector.
Value: string.
Definition: speakerRecipe.excluded_references
Explicit current-reference exclusions.
Value: array.
Definition: speakerRecipe.excluded_references[]
Exact recording/cue/local-speaker reference key.
Value: string.
Definition: speakerTrain
Elected durable speaker training input.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
dataset_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact valid current dataset. | |
family_id |
No | Reference: common.schema.json#/$defs/uuid | Optional existing output family. | |
name |
Yes | string | Speaker model display name. | |
output_kind |
No | string | Declared desired output kind. | |
adapter |
No | Reference: #/$defs/speakerAdapter | Exact elected training adapter. | |
base_model_id |
No | Reference: common.schema.json#/$defs/modelReference | Explicit immutable or alias base-model election. | |
pipeline_id |
No | Reference: common.schema.json#/$defs/uuid | Optional exact saved training configuration identity. | |
pipeline_revision |
No | integer | Exact elected pipeline revision. | |
parameters |
No | Reference: common.schema.json#/$defs/nonsecretOptions | Effective training hyperparameters without credentials. | |
checkpoint_id |
No | Reference: common.schema.json#/$defs/uuid | Exact compatible checkpoint to resume. |
At least one of the following alternatives must match:
Definition: speakerTrain: Alternative 1
Required fields: adapter, output_kind.
Definition: speakerTrain: Alternative 2
Required fields: pipeline_id, pipeline_revision.
Definition: speakerMatch
Matching-only election over frozen current roster profiles.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
model_id |
Yes | Reference: common.schema.json#/$defs/modelReference | Explicit embedding or matching model election. | |
adapter |
Yes | Reference: #/$defs/speakerAdapter | Exact elected matching adapter. | |
threshold |
Yes | number | Minimum accepted score with declared cosine similarity semantics. | |
ambiguity_margin |
Yes | number | Minimum score separation from the next eligible candidate. | |
min_evidence_us |
Yes | integer | Minimum current voice evidence duration. |
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "10000000-0000-4000-8000-000000000001",
"request_id": "10000000-0000-4000-8000-000000000002",
"operation": "workspace.show"
}
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"request_id": "22222222-2222-4222-8222-222222222222",
"operation": "pipelines.inspect",
"item_id": "66666666-6666-4666-8666-666666666666"
}
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"request_id": "22222222-2222-4222-8222-222222222222",
"operation": "terms.compile",
"data": {
"speaker_ids": [
"33333333-3333-4333-8333-333333333333"
],
"language": "en",
"max_hint_bytes": 200
}
}
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"request_id": "22222222-2222-4222-8222-222222222222",
"operation": "recordings.process",
"item_id": "44444444-4444-4444-8444-444444444444",
"data": {
"pipeline_id": "66666666-6666-4666-8666-666666666666",
"pipeline_revision": 1,
"transcription": "generate",
"diarization": "run"
}
}
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"request_id": "33333333-3333-4333-8333-333333333333",
"operation": "recordings.roster.replace",
"item_id": "44444444-4444-4444-8444-444444444444",
"data": {
"expected_revision": 0,
"speakers": [
"22222222-2222-4222-8222-222222222222"
]
}
}
Example
{
"schema_version": "1.0.0",
"kind": "runtime-request",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"request_id": "33333333-3333-4333-8333-333333333333",
"operation": "recordings.roster.clear",
"item_id": "44444444-4444-4444-8444-444444444444",
"data": {
"expected_revision": 0,
"speakers": []
}
}
Runtime response
A versioned operation result or redacted typed error. Early CLI errors omit unavailable identities; runtime replies include the workspace, request and session correlation.
Download runtime-response.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Shared software and contract version. | |
kind |
Yes | Constant "runtime-response" | Master-registry document discriminator. | |
workspace_id |
No | Reference: common.schema.json#/$defs/uuid | Workspace authority when known. | |
request_id |
No | Reference: common.schema.json#/$defs/uuid | Validated request correlation when known. | |
runtime_session_id |
No | Reference: common.schema.json#/$defs/uuid | Current runtime owner session when known. | |
result |
No | object | Operation-specific workspace, diagnostic or attempt result. Resolved credentials are excluded. | |
error |
No | object | Fixed redacted error code and message. |
result
Operation-specific workspace, diagnostic or attempt result. Resolved credentials are excluded.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
model_selections |
No | array | Exact selected models retained by a durable work election. | |
acquisition_ids |
No | array | Separate prerequisite work IDs; pending acquisition never means inference succeeded. | |
model_selection_count |
No | integer | Total frozen model/acquisition entries; bounded inspection may show only the first hundred. | |
acquisition_count |
No | integer | Total frozen model/acquisition entries; bounded inspection may show only the first hundred. |
result.model_selections
Exact selected models retained by a durable work election.
Value: array.
result.model_selections[]
Frozen exact model selection.
Value: Reference: common.schema.json#/$defs/modelResolution.
result.acquisition_ids
Separate prerequisite work IDs; pending acquisition never means inference succeeded.
Value: array.
result.acquisition_ids[]
Shared exact-bundle acquisition work identity.
Value: Reference: common.schema.json#/$defs/uuid.
error
Fixed redacted error code and message.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
code |
Yes | "invalid_request", "incompatible_version", "workspace_mismatch", "not_found", "conflict", "unavailable", "cancelled", "output_limit", "operation_failed", "timing_unavailable", "invalid_audio", "audio_limit", "unsupported_audio", "model_unavailable", "unsupported_capability", "input_limit", "invalid_engine_output", "invalid_timing", "engine_ci_forbidden", "engine_unavailable", "unsupported_device", "invalid_embedding", "model_acquisition_failed" | Stable machine-readable failure category. | |
message |
Yes | string | Fixed diagnostic text without raw child output or credential values. | |
diagnostics |
No | array | Redacted condition groups with complete represented occurrence counts and a first generated cue/media pointer, without raw child text. |
error.diagnostics
Redacted condition groups with complete represented occurrence counts and a first generated cue/media pointer, without raw child text.
Value: array.
error.diagnostics[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
pointer |
No | string | First generated current document occurrence. | |
count |
Yes | integer | Number of represented occurrences of this condition. | |
message |
Yes | string | Fixed locally authored explanation, never raw child output. | |
code |
Yes | string | Fixed current subtitle diagnostic vocabulary or redacted generic condition. |
Exactly one of the following alternatives must match:
Alternative 1
Required fields: result.
Disallowed combination: has error.
Alternative 2
Required fields: error.
Disallowed combination: has result.
Example
{
"schema_version": "1.0.0",
"kind": "runtime-response",
"error": {
"code": "unavailable",
"message": "The selected dependency is unavailable."
}
}
Speaker training dataset snapshot
Frozen ordered membership in current embedded recording evidence. A current-document or known-speaker mapping correction invalidates dependent membership and retires assignment-bearing manifests/preparations while retaining noncontent lineage.
Download speaker-dataset.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this portable document contract. | |
kind |
Yes | Constant "speaker-dataset" | Discriminator identifying an immutable speaker training dataset snapshot. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace owning the snapshot and every referenced member. | |
dataset_snapshot_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable immutable training_dataset_snapshot identity. | |
speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Originating catalog speaker for this selected corpus. | |
speaker_identity_revision |
Yes | Reference: common.schema.json#/$defs/revision | Exact identity revision used when selecting this speaker's corpus. | |
catalog_revision |
Yes | Reference: common.schema.json#/$defs/revision | Catalog revision against which selection was resolved. | |
created_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC instant when this snapshot was frozen. | |
manifest_sha256 |
Yes | At least one alternative | Current assignment-bearing manifest digest, or null after invalidation. | |
manifest_artifact |
No | At least one alternative | Current managed manifest, or null after retirement/invalidation. | |
selection |
Yes | Reference: #/$defs/selection | Complete frozen selection recipe and effective filters. | |
preparation |
Yes | At least one alternative | Current preparation recipe, or null after invalidation. | |
members |
Yes | array | Ordered included segment memberships; empty snapshots represent no matching corpus and do not imply runnable training. | |
exclusions |
Yes | array | Frozen excluded-segment decisions and their technical or user-supplied reasons. | |
summary |
Yes | Reference: #/$defs/summary | Frozen corpus totals and diagnostic summary. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced dataset metadata preserved without altering immutable membership. | |
state |
Yes | "current", "invalidated" | Whether current evidence still authorizes this frozen corpus. Invalidated lineage has no executable manifest or membership. |
manifest_sha256
Current assignment-bearing manifest digest, or null after invalidation.
At least one of the following alternatives must match:
manifest_sha256: Alternative 1
Current manifest content digest.
Value: Reference: common.schema.json#/$defs/sha256.
manifest_sha256: Alternative 2
Value: null.
manifest_artifact
Current managed manifest, or null after retirement/invalidation.
At least one of the following alternatives must match:
manifest_artifact: Alternative 1
Current manifest artifact.
Value: Reference: common.schema.json#/$defs/artifactReference.
manifest_artifact: Alternative 2
Value: null.
preparation
Current preparation recipe, or null after invalidation.
At least one of the following alternatives must match:
preparation: Alternative 1
Value: Reference: #/$defs/preparation.
preparation: Alternative 2
Value: null.
members
Ordered included segment memberships; empty snapshots represent no matching corpus and do not imply runnable training.
Value: array.
members[]
Value: Reference: #/$defs/member.
exclusions
Frozen excluded-segment decisions and their technical or user-supplied reasons.
Value: array.
exclusions[]
Value: Reference: #/$defs/exclusion.
All of the following constraints apply:
When state is "invalidated":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
members |
No | array | Invalidated corpora have no executable memberships. | |
manifest_sha256 |
No | null | Assignment-bearing digest is cleared after invalidation. | |
manifest_artifact |
No | null | Assignment-bearing artifact is cleared after invalidation. | |
preparation |
No | null | Assignment-bearing preparation is cleared after invalidation. |
Definition: selection
Exact effective selection recipe, allowing automatic corpus selection without segment-by-segment approval.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
recipe_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable selection recipe identity. | |
recipe_revision |
Yes | Reference: common.schema.json#/$defs/revision | Frozen recipe revision. | |
preset |
Yes | string | Readable preparation/diagnostic preset identity. | |
preset_version |
Yes | string | Version defining the chosen preset's behavior. | |
attribution_bases |
Yes | array | Allowed assignment bases; an empty array includes every declared basis. | |
source_asset_ids |
Yes | array | Optional source filter; an empty array covers the speaker's whole workspace corpus. | |
languages |
Yes | array | Optional language filter; an empty array is language-independent. | |
minimum_duration_us |
Yes | integer | Minimum original segment duration considered by this recipe. | |
maximum_duration_us |
Yes | At least one alternative | Upper segment-duration bound, or null when no upper bound is configured. | |
explicitly_excluded_segment_ids |
Yes | array | User-selected exclusions applied automatically to this snapshot. | |
options |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Adapter-specific filters and quality thresholds validated by the selected preset/adapter. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced custom selection rules with documented adapter interpretation. |
Definition: selection.attribution_bases
Allowed assignment bases; an empty array includes every declared basis.
Value: array.
Definition: selection.attribution_bases[]
One included attribution basis.
Value: string.
Definition: selection.source_asset_ids
Optional source filter; an empty array covers the speaker's whole workspace corpus.
Value: array.
Definition: selection.source_asset_ids[]
One included original media asset.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: selection.languages
Optional language filter; an empty array is language-independent.
Value: array.
Definition: selection.languages[]
One declared language identifier.
Value: string.
Definition: selection.maximum_duration_us
Upper segment-duration bound, or null when no upper bound is configured.
At least one of the following alternatives must match:
Definition: selection.maximum_duration_us: Alternative 1
Maximum original segment duration considered by this recipe.
Value: integer.
Definition: selection.maximum_duration_us: Alternative 2
Value: null.
Definition: selection.explicitly_excluded_segment_ids
User-selected exclusions applied automatically to this snapshot.
Value: array.
Definition: selection.explicitly_excluded_segment_ids[]
Excluded stable segment identity.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: preparation
Frozen requested preparation contract; final prepared bytes are bound by a separate immutable preparation manifest.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter_id |
Yes | string | Selected preparation adapter identity. | |
contract_version |
Yes | string | Version of the preparation request/result contract. | |
adapter_version |
Yes | string | Version of the selected adapter implementation. | |
options |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Exact audio preparation options without credentials or temporary paths. | |
transcript_required |
Yes | boolean | Whether this training input requires selected transcript and alignment references. | |
output_format |
Yes | At least one alternative | Requested audio format, or null when the adapter consumes source streams directly. | |
sample_rate_hz |
Yes | At least one alternative | Requested sample rate, or null when unchanged or not applicable. | |
channel_count |
Yes | At least one alternative | Requested output channel count, or null when unchanged or not applicable. |
Definition: preparation.output_format
Requested audio format, or null when the adapter consumes source streams directly.
At least one of the following alternatives must match:
Definition: preparation.output_format: Alternative 1
Requested prepared audio format.
Value: string.
Definition: preparation.output_format: Alternative 2
Value: null.
Definition: preparation.sample_rate_hz
Requested sample rate, or null when unchanged or not applicable.
At least one of the following alternatives must match:
Definition: preparation.sample_rate_hz: Alternative 1
Requested prepared sample rate in hertz.
Value: integer.
Definition: preparation.sample_rate_hz: Alternative 2
Value: null.
Definition: preparation.channel_count
Requested output channel count, or null when unchanged or not applicable.
At least one of the following alternatives must match:
Definition: preparation.channel_count: Alternative 1
Requested prepared channel count.
Value: integer.
Definition: preparation.channel_count: Alternative 2
Value: null.
Definition: member
Reference-only frozen membership. Resolve against current recording authority before preparation; a superseded digest invalidates this corpus.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
ordinal |
Yes | integer | Frozen member order. | |
segment_id |
Yes | Reference: common.schema.json#/$defs/uuid | Immutable segment reference identity. | |
segment_revision |
Yes | Reference: common.schema.json#/$defs/revision | Exact segment reference revision. | |
recording_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current recording owning the embedded Cueson evidence. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Exact current embedded document digest; stale references fail resolution. | |
cue_id |
Yes | string | Cue identity inside the current embedded document. | |
local_speaker_id |
Yes | Reference: common.schema.json#/$defs/localSpeakerID | Recording-scoped local speaker token occurring in this cue attribution. | |
source_digest |
No | Reference: common.schema.json#/$defs/sha256 | Exact canonical audio content digest resolved for this current reference. | |
source_map_digest |
No | Reference: common.schema.json#/$defs/sha256 | Exact canonical source-clock mapping digest resolved for this current reference. | |
mapping_revision |
No | Reference: common.schema.json#/$defs/revision | Revision of the independent manual mapping used for this current reference. |
Definition: exclusion
One explicit selection exclusion retained for explainable automatic corpus selection.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
segment_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable segment excluded from this snapshot. | |
segment_revision |
Yes | Reference: common.schema.json#/$defs/revision | Segment revision evaluated by this decision. | |
reason_codes |
Yes | array | Declared reasons for exclusion, such as duplicate-source-span or configured-overlap-filter. | |
method |
Yes | string | Preset/adapter or user action responsible for the decision. | |
method_version |
Yes | string | Version of the method when this exclusion was computed. | |
details |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Nonsecret diagnostic values and effective thresholds explaining the decision. |
Definition: exclusion.reason_codes
Declared reasons for exclusion, such as duplicate-source-span or configured-overlap-filter.
Value: array.
Definition: exclusion.reason_codes[]
One machine-readable reason code.
Value: string.
Definition: summary
Totals frozen when selection completes; the application verifies consistency against membership.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
segment_count |
Yes | integer | Number of included members. | |
source_asset_count |
Yes | integer | Distinct original source assets represented by included members. | |
original_duration_us |
Yes | integer | Sum of selected original intervals in integer microseconds after the recorded deduplication policy. | |
prepared_duration_us |
Yes | At least one alternative | Known prepared duration, or null until preparation is materialized. | |
excluded_segment_count |
Yes | integer | Number of excluded segment decisions retained in this snapshot. | |
diagnostic_counts |
Yes | object | Counts keyed by declared technical diagnostic code. | |
languages |
Yes | array | Language identifiers observed or selected for the included corpus. |
Definition: summary.prepared_duration_us
Known prepared duration, or null until preparation is materialized.
At least one of the following alternatives must match:
Definition: summary.prepared_duration_us: Alternative 1
Known prepared duration in integer microseconds.
Value: integer.
Definition: summary.prepared_duration_us: Alternative 2
Value: null.
Definition: summary.diagnostic_counts
Counts keyed by declared technical diagnostic code.
Value: object.
Definition: summary.diagnostic_counts{name}
Value: integer.
Definition: summary.languages
Language identifiers observed or selected for the included corpus.
Value: array.
Definition: summary.languages[]
One language identifier.
Value: string.
Example
{
"schema_version": "1.0.0",
"kind": "speaker-dataset",
"workspace_id": "00000000-0000-4000-8000-00000000000a",
"dataset_snapshot_id": "00000000-0000-4000-8000-00000000000b",
"speaker_id": "00000000-0000-4000-8000-000000000006",
"speaker_identity_revision": 1,
"catalog_revision": 1,
"created_at": {
"iso": "2026-10-04T20:01:00Z",
"unix_ns": 1791144060000000000
},
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"selection": {
"recipe_id": "00000000-0000-4000-8000-00000000000c",
"recipe_revision": 1,
"preset": "speech-clean",
"preset_version": "1.0.0",
"attribution_bases": [],
"source_asset_ids": [],
"languages": [],
"minimum_duration_us": 0,
"maximum_duration_us": null,
"explicitly_excluded_segment_ids": [],
"options": {
"exclude_duplicate_source_spans": true
}
},
"preparation": {
"adapter_id": "example.audio-preparation",
"contract_version": "1",
"adapter_version": "1.0.0",
"options": {
"normalize": false
},
"transcript_required": false,
"output_format": "wav-pcm-s16le",
"sample_rate_hz": 16000,
"channel_count": 1
},
"members": [
{
"ordinal": 0,
"segment_id": "00000000-0000-4000-8000-000000000001",
"segment_revision": 1,
"recording_id": "00000000-0000-4000-8000-000000000002",
"document_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"cue_id": "cue-000000",
"local_speaker_id": "00000000-0000-4000-8000-000000000003"
}
],
"exclusions": [],
"summary": {
"segment_count": 1,
"source_asset_count": 1,
"original_duration_us": 2000000,
"prepared_duration_us": null,
"excluded_segment_count": 0,
"diagnostic_counts": {},
"languages": []
},
"state": "current"
}
Speaker model version manifest
Exact model artifact identity and noncontent training lineage. Source authority corrections invalidate and retire assignment-bearing manifests/preparations; retained weights do not authorize obsolete subtitle or person assignments.
Download speaker-model.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this portable model-version document contract. | |
kind |
Yes | Constant "speaker-model" | Discriminator identifying a speaker-associated model-version manifest. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace owning this model family and version. | |
model_family_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable speaker_model family identity. | |
model_version_id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact immutable speaker_model_version identity fetched by the CLI. | |
originating_speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Original speaker identity retained through later merges or splits. | |
originating_speaker_identity_revision |
Yes | Reference: common.schema.json#/$defs/revision | Speaker identity revision used when this version was trained. | |
created_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC instant when this immutable model version was published. | |
manifest_sha256 |
Yes | At least one alternative | Current assignment-bearing manifest digest, or null after invalidation. | |
manifest_artifact |
No | At least one alternative | Current manifest artifact, or null after invalidation. | |
display_name |
No | string | User-facing name captured when the version was published; current family names live in revisioned catalog state. | |
training |
Yes | Reference: #/$defs/training | Exact training run, dataset, preparation and provider lineage. | |
outputs |
Yes | Reference: #/$defs/outputs | Verified downloadable artifacts or a declared hosted-model handle. | |
compatibility |
Yes | Reference: #/$defs/compatibility | Model-kind and consumer/runtime compatibility declarations. | |
checkpoints |
Yes | array | Optional immutable checkpoints retained with the producing training run. | |
license_declarations |
Yes | array | Declared upstream/output licenses and explicit unknown declarations. | |
evaluations |
Yes | array | Optional method-qualified metrics produced before publication. | |
diagnostics |
Yes | array | Technical findings recorded at publication; later lineage/availability findings are separate revisioned catalog observations. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced custom model metadata without redefining frozen provenance. | |
state |
Yes | "current", "invalidated" | Whether the input corpus remains current; invalidated lineage retains model outputs without executable assignment-bearing input manifests. |
manifest_sha256
Current assignment-bearing manifest digest, or null after invalidation.
At least one of the following alternatives must match:
manifest_sha256: Alternative 1
Current model manifest digest.
Value: Reference: common.schema.json#/$defs/sha256.
manifest_sha256: Alternative 2
Value: null.
manifest_artifact
Current manifest artifact, or null after invalidation.
At least one of the following alternatives must match:
manifest_artifact: Alternative 1
Current model manifest artifact.
Value: Reference: common.schema.json#/$defs/artifactReference.
manifest_artifact: Alternative 2
Value: null.
checkpoints
Optional immutable checkpoints retained with the producing training run.
Value: array.
checkpoints[]
One training checkpoint and resume declaration.
Value: Reference: #/$defs/checkpoint.
license_declarations
Declared upstream/output licenses and explicit unknown declarations.
Value: array.
license_declarations[]
One source-qualified license/attribution statement.
Value: Reference: #/$defs/licenseDeclaration.
evaluations
Optional method-qualified metrics produced before publication.
Value: array.
evaluations[]
One measured evaluation report.
Value: Reference: #/$defs/evaluation.
diagnostics
Technical findings recorded at publication; later lineage/availability findings are separate revisioned catalog observations.
Value: array.
diagnostics[]
One method-qualified model diagnostic.
Value: Reference: speaker-segments.schema.json#/$defs/diagnostic.
All of the following constraints apply:
When state is "invalidated":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
manifest_sha256 |
No | null | Assignment-bearing digest is cleared after invalidation. | |
manifest_artifact |
No | null | Assignment-bearing artifact is cleared after invalidation. | |
training |
No | object | Training lineage carries current or invalidated input references. |
training
Training lineage carries current or invalidated input references.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
preparation |
No | null | Assignment-bearing preparation is cleared after invalidation. | |
dataset |
No | object | Dataset lineage carries its current evidence state. |
training.dataset
Dataset lineage carries its current evidence state.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "invalidated" | Evidence-state condition selecting current or invalidated lineage. | |
manifest_sha256 |
No | null | Assignment-bearing digest is cleared after invalidation. |
Definition: baseModel
Exact upstream/base-model identity when training depends on an existing model; no installed path or secret-bearing URL is retained.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
model_id |
Yes | string | Stable upstream or configured base-model identity. | |
revision |
Yes | At least one alternative | Upstream revision, or null when the provider supplies none. | |
sha256 |
Yes | At least one alternative | Known immutable content digest, or null for a provider-managed model without downloadable bytes. | |
artifact |
No | Reference: common.schema.json#/$defs/artifactReference | Optional locally managed base-model artifact reference. | |
format |
Yes | At least one alternative | Known model format, or null when the provider does not declare it. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced upstream identity facts without credentials or local paths. |
Definition: baseModel.revision
Upstream revision, or null when the provider supplies none.
At least one of the following alternatives must match:
Definition: baseModel.revision: Alternative 1
Declared immutable upstream revision.
Value: string.
Definition: baseModel.revision: Alternative 2
Value: null.
Definition: baseModel.sha256
Known immutable content digest, or null for a provider-managed model without downloadable bytes.
At least one of the following alternatives must match:
Definition: baseModel.sha256: Alternative 1
Verified base-model content digest.
Value: Reference: common.schema.json#/$defs/sha256.
Definition: baseModel.sha256: Alternative 2
Value: null.
Definition: baseModel.format
Known model format, or null when the provider does not declare it.
At least one of the following alternatives must match:
Definition: baseModel.format: Alternative 1
Declared base-model serialization format.
Value: string.
Definition: baseModel.format: Alternative 2
Value: null.
Definition: provider
Execution identity sufficient to distinguish local and hosted training provenance.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
execution |
Yes | "local", "hosted" | Whether training ran locally or at the selected hosted provider. | |
provider_id |
Yes | string | Stable configured provider identity, independent of transient access credentials. | |
adapter_id |
Yes | string | Training adapter identity. | |
contract_version |
Yes | string | Version of the training request/result contract. | |
adapter_version |
Yes | string | Exact implementation version of the producing adapter. | |
endpoint |
No | Reference: common.schema.json#/$defs/endpoint | Optional configured service endpoint without user information, tokens or fragments. | |
credential_id |
No | Reference: common.schema.json#/$defs/credentialId | Optional opaque credential reference; never a credential value. | |
implementation_sha256 |
No | Reference: common.schema.json#/$defs/sha256 | Optional verified local worker/executable distribution digest. | |
provider_request_id |
No | string | Optional nonsecret provider request/operation identity. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced provider-specific execution facts. |
Definition: datasetReference
Noncontent dataset identity and current-state lineage; copied speaker assignments are forbidden.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
dataset_snapshot_id |
Yes | Reference: common.schema.json#/$defs/uuid | training_dataset_snapshot identity used by the run. | |
manifest_sha256 |
Yes | At least one alternative | Corpus manifest digest, or null after evidence invalidation. | |
originating_speaker_id |
Yes | Reference: common.schema.json#/$defs/uuid | Speaker for which the dataset was selected. | |
speaker_identity_revision |
Yes | Reference: common.schema.json#/$defs/revision | Frozen speaker identity revision used by dataset selection. | |
artifact |
No | Reference: common.schema.json#/$defs/artifactReference | Optional immutable dataset manifest artifact reference. | |
state |
Yes | "current", "invalidated" | Current or invalidated corpus lineage. |
Definition: datasetReference.manifest_sha256
Corpus manifest digest, or null after evidence invalidation.
At least one of the following alternatives must match:
Definition: datasetReference.manifest_sha256: Alternative 1
Current corpus manifest digest.
Value: Reference: common.schema.json#/$defs/sha256.
Definition: datasetReference.manifest_sha256: Alternative 2
Value: null.
Definition: preparationReference
Immutable receipt binding every final training input back to the frozen dataset members.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
preparation_manifest_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable identity of the training_preparation_manifest. | |
manifest_sha256 |
Yes | Reference: common.schema.json#/$defs/sha256 | Expected canonical preparation manifest digest. | |
artifact |
Yes | All listed constraints | Published noncontent preparation receipt with exact current member/input hashes and source-clock provenance; transient audio and text need not be retained. | |
input_artifact_ids |
Yes | array | Durable prepared media artifact identities when retained; empty when verified prepared clips are transient and their hashes/current-source references are recorded in the preparation manifest. | |
adapter_id |
Yes | string | Adapter that prepared the final training inputs. | |
adapter_version |
Yes | string | Implementation version of the preparation adapter. | |
options |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Exact effective preparation options recorded in the manifest. |
Definition: preparationReference.artifact
Published noncontent preparation receipt with exact current member/input hashes and source-clock provenance; transient audio and text need not be retained.
All of the following constraints apply:
Definition: preparationReference.artifact: Alternative 1
Published preparation manifest bytes, including exact member/input-artifact maps.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: preparationReference.artifact: Alternative 2
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
byte_length |
Yes | integer | A preparation JSON receipt has nonempty verified bytes. |
Definition: preparationReference.input_artifact_ids
Durable prepared media artifact identities when retained; empty when verified prepared clips are transient and their hashes/current-source references are recorded in the preparation manifest.
Value: array.
Definition: preparationReference.input_artifact_ids[]
One final immutable training input artifact.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: training
Durable training execution and all immutable input identities for this published model version.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
training_run_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable training_run identity. | |
job_id |
Yes | Reference: common.schema.json#/$defs/uuid | Durable scheduler job identity. | |
producing_attempt_id |
Yes | Reference: common.schema.json#/$defs/uuid | Job attempt that produced the published output. | |
pipeline_id |
Yes | Reference: common.schema.json#/$defs/uuid | Saved training pipeline identity. | |
pipeline_revision |
Yes | Reference: common.schema.json#/$defs/revision | Frozen pipeline revision used by the run. | |
dataset |
Yes | Reference: #/$defs/datasetReference | Frozen dataset lineage and exact attribution revisions. | |
preparation |
Yes | At least one alternative | Current final-input preparation, or null when the corpus is invalidated. | |
provider |
Yes | Reference: #/$defs/provider | Producing adapter and local/hosted execution identity. | |
base_model |
Yes | At least one alternative | Base-model dependency, or null when training did not use one. | |
parameters |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Exact effective training hyperparameters and options; adapter-specific values remain extensible. | |
started_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC instant when this training run started. | |
completed_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC instant when the producing attempt completed. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced run provenance with no secret values. |
Definition: training.preparation
Current final-input preparation, or null when the corpus is invalidated.
At least one of the following alternatives must match:
Definition: training.preparation: Alternative 1
Value: Reference: #/$defs/preparationReference.
Definition: training.preparation: Alternative 2
Value: null.
Definition: training.base_model
Base-model dependency, or null when training did not use one.
At least one of the following alternatives must match:
Definition: training.base_model: Alternative 1
Exact upstream/base-model identity.
Value: Reference: #/$defs/baseModel.
Definition: training.base_model: Alternative 2
Value: null.
Definition: modelArtifact
One immutable output file belonging to this model version.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
role |
Yes | string | Declared artifact role, such as weights, config, tokenizer, reference-audio or custom adapter role. | |
artifact |
Yes | All listed constraints | Verified durable output artifact identity and complete byte digest/length. | |
format |
Yes | string | Declared serialization/container format. | |
required_for |
Yes | array | Operations that require this artifact, using declared operation identifiers. | |
dependencies |
Yes | array | Other immutable artifact IDs required to interpret this output. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced format-specific output metadata. |
Definition: modelArtifact.artifact
Verified durable output artifact identity and complete byte digest/length.
All of the following constraints apply:
Definition: modelArtifact.artifact: Alternative 1
Verified durable output artifact identity and complete byte digest/length.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: modelArtifact.artifact: Alternative 2
Value: object.
Required fields: sha256, byte_length.
Definition: modelArtifact.required_for
Operations that require this artifact, using declared operation identifiers.
Value: array.
Definition: modelArtifact.required_for[]
One supported operation identifier.
Value: string.
Definition: modelArtifact.dependencies
Other immutable artifact IDs required to interpret this output.
Value: array.
Definition: modelArtifact.dependencies[]
Required companion artifact identity.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: hostedModel
Provider-managed model output; the handle is a stable nonsecret identifier rather than downloadable weights.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
provider_id |
Yes | string | Configured provider identity owning this model handle. | |
provider_model_id |
Yes | string | Stable provider model identifier without credentials or transient signed URLs. | |
downloadable |
Yes | boolean | Whether the declared provider adapter supports retrieving model bytes. | |
supported_operations |
Yes | array | Operations supported by this hosted model according to its adapter declaration. | |
retrieval_adapter_id |
Yes | At least one alternative | Declared download adapter, or null when weights are not retrievable. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced provider output metadata without access secrets. |
Definition: hostedModel.supported_operations
Operations supported by this hosted model according to its adapter declaration.
Value: array.
Definition: hostedModel.supported_operations[]
One supported operation.
Value: string.
Definition: hostedModel.retrieval_adapter_id
Declared download adapter, or null when weights are not retrievable.
At least one of the following alternatives must match:
Definition: hostedModel.retrieval_adapter_id: Alternative 1
Adapter capable of retrieving weights.
Value: string.
Definition: hostedModel.retrieval_adapter_id: Alternative 2
Value: null.
Definition: outputs
Validated output manifest; at least one durable artifact or hosted model handle must exist.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifacts |
Yes | array | Durable files available for exact-version retrieval. | |
hosted_model |
No | Reference: #/$defs/hostedModel | Optional hosted-only or additional provider model handle. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced output formats declared by a custom training adapter. |
Definition: outputs.artifacts
Durable files available for exact-version retrieval.
Value: array.
Definition: outputs.artifacts[]
One verified output file.
Value: Reference: #/$defs/modelArtifact.
At least one of the following alternatives must match:
Definition: outputs: Alternative 1
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifacts |
Yes | array | A downloadable artifact output contains at least one file. |
Definition: outputs: Alternative 2
Value: object.
Required fields: hosted_model.
Definition: compatibility
Declared compatibility of this version; declarations are recorded without claiming unperformed runtime verification.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
model_kind |
Yes | string | Declared type, such as voice-embedding, speech-synthesis or a custom adapter-defined model kind. | |
architecture |
Yes | At least one alternative | Model architecture, or null when undeclared by the producing provider. | |
supported_operations |
Yes | array | Operations this model version declares it can support. | |
consumers |
Yes | array | Consumer adapter requirements for local or hosted use. | |
runtime_dependencies |
Yes | array | Declared software/runtime dependencies; no local install paths are carried. | |
sample_rate_hz |
Yes | At least one alternative | Declared input/output sample rate where relevant, or null when not applicable or undeclared. | |
channel_count |
Yes | At least one alternative | Declared audio channel count where relevant, or null when not applicable or undeclared. | |
languages |
Yes | array | Declared supported language identifiers; an empty array makes no language-support claim. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Custom architecture/capability declarations interpreted by the relevant adapter. |
Definition: compatibility.architecture
Model architecture, or null when undeclared by the producing provider.
At least one of the following alternatives must match:
Definition: compatibility.architecture: Alternative 1
Declared model architecture.
Value: string.
Definition: compatibility.architecture: Alternative 2
Value: null.
Definition: compatibility.supported_operations
Operations this model version declares it can support.
Value: array.
Definition: compatibility.supported_operations[]
One operation identifier.
Value: string.
Definition: compatibility.consumers
Consumer adapter requirements for local or hosted use.
Value: array.
Definition: compatibility.consumers[]
Compatibility declaration for one consuming adapter.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter_id |
Yes | string | Consumer adapter identity. | |
contract_version |
Yes | string | Consumer contract version. | |
implementation_version_range |
Yes | string | Declared compatible implementation version or range. | |
accepted_formats |
Yes | array | Formats accepted by this consuming adapter. |
Definition: compatibility.consumers[].accepted_formats
Formats accepted by this consuming adapter.
Value: array.
Definition: compatibility.consumers[].accepted_formats[]
One model format.
Value: string.
Definition: compatibility.runtime_dependencies
Declared software/runtime dependencies; no local install paths are carried.
Value: array.
Definition: compatibility.runtime_dependencies[]
One dependency compatibility declaration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
name |
Yes | string | Dependency distribution or runtime identity. | |
version_requirement |
Yes | string | Declared compatible version or range. | |
purpose |
Yes | string | How this dependency is used by the model consumer. |
Definition: compatibility.sample_rate_hz
Declared input/output sample rate where relevant, or null when not applicable or undeclared.
At least one of the following alternatives must match:
Definition: compatibility.sample_rate_hz: Alternative 1
Value: integer.
Definition: compatibility.sample_rate_hz: Alternative 2
Value: null.
Definition: compatibility.channel_count
Declared audio channel count where relevant, or null when not applicable or undeclared.
At least one of the following alternatives must match:
Definition: compatibility.channel_count: Alternative 1
Value: integer.
Definition: compatibility.channel_count: Alternative 2
Value: null.
Definition: compatibility.languages
Declared supported language identifiers; an empty array makes no language-support claim.
Value: array.
Definition: compatibility.languages[]
One declared language identifier.
Value: string.
Definition: checkpoint
Immutable training checkpoint and its resume-compatibility declaration; a checkpoint does not itself assert a completed model.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
checkpoint_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable training_checkpoint identity. | |
producing_attempt_id |
Yes | Reference: common.schema.json#/$defs/uuid | Attempt that emitted this checkpoint. | |
training_step |
Yes | integer | Training step reported by the adapter. | |
format |
Yes | string | Declared checkpoint serialization or provider format. | |
artifact |
No | All listed constraints | Optional verified checkpoint bytes. | |
hosted_handle |
No | string | Optional stable nonsecret provider checkpoint identifier. | |
resume_supported |
Yes | boolean | Whether the producing adapter declares this checkpoint resumable. | |
compatible_adapter_id |
Yes | string | Adapter identity declaring resume compatibility. | |
compatible_adapter_version |
Yes | string | Compatible implementation version or range. | |
base_model |
Yes | At least one alternative | Required base-model identity for resume, or null when none is required. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced checkpoint compatibility facts. |
Definition: checkpoint.artifact
Optional verified checkpoint bytes.
All of the following constraints apply:
Definition: checkpoint.artifact: Alternative 1
Optional verified checkpoint bytes.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: checkpoint.artifact: Alternative 2
Value: object.
Required fields: sha256, byte_length.
Definition: checkpoint.base_model
Required base-model identity for resume, or null when none is required.
At least one of the following alternatives must match:
Definition: checkpoint.base_model: Alternative 1
Exact base-model requirement for resume.
Value: Reference: #/$defs/baseModel.
Definition: checkpoint.base_model: Alternative 2
Value: null.
At least one of the following alternatives must match:
Definition: checkpoint: Alternative 1
Value: object.
Required fields: artifact.
Definition: checkpoint: Alternative 2
Value: object.
Required fields: hosted_handle.
Definition: licenseDeclaration
License/attribution statement preserved as metadata, with explicit unknown values rather than an invented eligibility policy.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
scope |
Yes | string | Material covered by the declaration, such as base-model, output or training-data. | |
declared_license |
Yes | At least one alternative | Declared license, or null when no declaration was supplied. | |
attribution |
Yes | At least one alternative | Supplied attribution text, or null when absent. | |
source_basis |
Yes | string | Origin of the declaration, such as upstream-manifest, provider-report or user-entry. | |
source_artifact |
No | Reference: common.schema.json#/$defs/artifactReference | Optional report/manifest artifact containing the declaration. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced rights metadata as supplied by the upstream source. |
Definition: licenseDeclaration.declared_license
Declared license, or null when no declaration was supplied.
At least one of the following alternatives must match:
Definition: licenseDeclaration.declared_license: Alternative 1
Declared license expression or upstream name.
Value: string.
Definition: licenseDeclaration.declared_license: Alternative 2
Value: null.
Definition: licenseDeclaration.attribution
Supplied attribution text, or null when absent.
At least one of the following alternatives must match:
Definition: licenseDeclaration.attribution: Alternative 1
Required or supplied attribution text.
Value: string.
Definition: licenseDeclaration.attribution: Alternative 2
Value: null.
Definition: evaluation
Method-qualified training/evaluation metrics; no unmeasured quality claim is implied.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
method |
Yes | string | Evaluation method identity. | |
method_version |
Yes | string | Version of the evaluation method. | |
metrics |
Yes | object | Named measurements reported by this method; absent measurements are not fabricated. | |
report_artifact |
No | Reference: common.schema.json#/$defs/artifactReference | Optional immutable evaluation report. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced evaluation context without library content or credentials by default. |
Definition: evaluation.metrics
Named measurements reported by this method; absent measurements are not fabricated.
Value: object.
Definition: evaluation.metrics{name}
At least one of the following alternatives must match:
Definition: evaluation.metrics{name}: Alternative 1
Value: number.
Definition: evaluation.metrics{name}: Alternative 2
Value: string.
Definition: evaluation.metrics{name}: Alternative 3
Value: null.
Example
{
"schema_version": "1.0.0",
"kind": "speaker-model",
"workspace_id": "00000000-0000-4000-8000-00000000000a",
"model_family_id": "00000000-0000-4000-8000-000000000014",
"model_version_id": "00000000-0000-4000-8000-000000000015",
"originating_speaker_id": "00000000-0000-4000-8000-000000000006",
"originating_speaker_identity_revision": 1,
"created_at": {
"iso": "2026-10-04T20:05:00Z",
"unix_ns": 1791144300000000000
},
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"display_name": "Example speaker model",
"training": {
"training_run_id": "00000000-0000-4000-8000-00000000000d",
"job_id": "00000000-0000-4000-8000-00000000000e",
"producing_attempt_id": "00000000-0000-4000-8000-00000000000f",
"pipeline_id": "00000000-0000-4000-8000-000000000010",
"pipeline_revision": 1,
"dataset": {
"dataset_snapshot_id": "00000000-0000-4000-8000-00000000000b",
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"originating_speaker_id": "00000000-0000-4000-8000-000000000006",
"speaker_identity_revision": 1,
"state": "current"
},
"preparation": {
"preparation_manifest_id": "00000000-0000-4000-8000-000000000011",
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"artifact": {
"artifact_id": "00000000-0000-4000-8000-000000000012",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"byte_length": 1024
},
"input_artifact_ids": [
"00000000-0000-4000-8000-000000000013"
],
"adapter_id": "example.audio-preparation",
"adapter_version": "1.0.0",
"options": {
"normalize": false
}
},
"provider": {
"execution": "local",
"provider_id": "local",
"adapter_id": "example.voice-training",
"contract_version": "1",
"adapter_version": "1.0.0"
},
"base_model": null,
"parameters": {
"epochs": 2
},
"started_at": {
"iso": "2026-10-04T20:02:00Z",
"unix_ns": 1791144120000000000
},
"completed_at": {
"iso": "2026-10-04T20:04:00Z",
"unix_ns": 1791144240000000000
}
},
"outputs": {
"artifacts": [
{
"role": "weights",
"artifact": {
"artifact_id": "00000000-0000-4000-8000-000000000016",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"byte_length": 4096
},
"format": "example-voice-format",
"required_for": [
"voice-comparison"
],
"dependencies": []
}
]
},
"compatibility": {
"model_kind": "voice-embedding",
"architecture": "example-encoder",
"supported_operations": [
"voice-comparison"
],
"consumers": [
{
"adapter_id": "example.voice-matcher",
"contract_version": "1",
"implementation_version_range": "1.x",
"accepted_formats": [
"example-voice-format"
]
}
],
"runtime_dependencies": [],
"sample_rate_hz": 16000,
"channel_count": 1,
"languages": []
},
"checkpoints": [],
"license_declarations": [
{
"scope": "output",
"declared_license": null,
"attribution": null,
"source_basis": "provider-report"
}
],
"evaluations": [],
"diagnostics": [],
"state": "current"
}
Example
{
"schema_version": "1.0.0",
"kind": "speaker-model",
"workspace_id": "00000000-0000-4000-8000-00000000000a",
"model_family_id": "00000000-0000-4000-8000-000000000014",
"model_version_id": "00000000-0000-4000-8000-000000000017",
"originating_speaker_id": "00000000-0000-4000-8000-000000000006",
"originating_speaker_identity_revision": 1,
"created_at": {
"iso": "2026-10-04T20:05:00Z",
"unix_ns": 1791144300000000000
},
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"display_name": "Example speaker model",
"training": {
"training_run_id": "00000000-0000-4000-8000-00000000000d",
"job_id": "00000000-0000-4000-8000-00000000000e",
"producing_attempt_id": "00000000-0000-4000-8000-00000000000f",
"pipeline_id": "00000000-0000-4000-8000-000000000010",
"pipeline_revision": 1,
"dataset": {
"dataset_snapshot_id": "00000000-0000-4000-8000-00000000000b",
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"originating_speaker_id": "00000000-0000-4000-8000-000000000006",
"speaker_identity_revision": 1,
"state": "current"
},
"preparation": {
"preparation_manifest_id": "00000000-0000-4000-8000-000000000011",
"manifest_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"artifact": {
"artifact_id": "00000000-0000-4000-8000-000000000012",
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"byte_length": 1024
},
"input_artifact_ids": [
"00000000-0000-4000-8000-000000000013"
],
"adapter_id": "example.audio-preparation",
"adapter_version": "1.0.0",
"options": {
"normalize": false
}
},
"provider": {
"execution": "hosted",
"provider_id": "example.hosted-training",
"adapter_id": "example.hosted-voice-training",
"contract_version": "1",
"adapter_version": "1.0.0",
"endpoint": "https://training.example.com",
"credential_id": "00000000-0000-4000-8000-000000000018"
},
"base_model": null,
"parameters": {
"epochs": 2
},
"started_at": {
"iso": "2026-10-04T20:02:00Z",
"unix_ns": 1791144120000000000
},
"completed_at": {
"iso": "2026-10-04T20:04:00Z",
"unix_ns": 1791144240000000000
}
},
"outputs": {
"artifacts": [],
"hosted_model": {
"provider_id": "example.hosted-training",
"provider_model_id": "model-example-001",
"downloadable": false,
"supported_operations": [
"voice-comparison"
],
"retrieval_adapter_id": null
}
},
"compatibility": {
"model_kind": "voice-embedding",
"architecture": null,
"supported_operations": [
"voice-comparison"
],
"consumers": [
{
"adapter_id": "example.hosted-voice-matcher",
"contract_version": "1",
"implementation_version_range": "1.x",
"accepted_formats": [
"provider-handle"
]
}
],
"runtime_dependencies": [],
"sample_rate_hz": null,
"channel_count": null,
"languages": []
},
"checkpoints": [],
"license_declarations": [
{
"scope": "output",
"declared_license": null,
"attribution": null,
"source_basis": "provider-report"
}
],
"evaluations": [],
"diagnostics": [],
"state": "current"
}
Speaker audio segment catalog
Portable current speaker-evidence references across the workspace library. Embedded Cueson owns cue timing and local attribution; current catalog mappings own optional known-person identity.
Download speaker-segments.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this portable document contract. | |
kind |
Yes | Constant "speaker-segments" | Discriminator identifying this document contract. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Workspace owning every segment and referenced catalog identity. | |
catalog_revision |
Yes | Reference: common.schema.json#/$defs/revision | Catalog revision observed by this result. | |
generated_at |
Yes | Reference: common.schema.json#/$defs/utcInstant | UTC instant when this result was generated. | |
speaker_filter |
Yes | At least one alternative | Requested speaker identity, or null for an unfiltered segment result. | |
segments |
Yes | array | Ordered source-linked segment records; an empty query result is valid. | |
next_cursor |
No | At least one alternative | Pagination continuation token, or null when complete. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Namespaced result metadata for custom segment adapters. |
speaker_filter
Requested speaker identity, or null for an unfiltered segment result.
At least one of the following alternatives must match:
speaker_filter: Alternative 1
Catalog speaker requested by this query.
Value: Reference: common.schema.json#/$defs/uuid.
speaker_filter: Alternative 2
Value: null.
segments
Ordered source-linked segment records; an empty query result is valid.
Value: array.
segments[]
Value: Reference: #/$defs/segment.
next_cursor
Pagination continuation token, or null when complete.
At least one of the following alternatives must match:
next_cursor: Alternative 1
Opaque continuation cursor without secrets.
Value: string.
next_cursor: Alternative 2
Value: null.
Definition: diagnostic
A nonsecret method-qualified processing or selection finding.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
code |
Yes | string | Stable diagnostic code. | |
severity |
Yes | "info", "warning", "error" | Severity of the technical diagnostic. | |
message |
Yes | string | Human-readable explanation without credentials or storage paths. | |
method |
No | string | Method or adapter that produced this finding. | |
method_version |
No | string | Version of the producing method. | |
details |
No | object | Adapter-specific structured diagnostic measurements; must not contain secrets or local storage locations. |
Definition: preparedAudio
Materialized audio and its reproducible mapping back to the original source.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
audio_artifact |
Yes | All listed constraints | Immutable extracted/prepared audio bytes. | |
time_map_artifact |
Yes | All listed constraints | Immutable mapping from prepared audio intervals to original-source intervals. | |
transform_artifact |
Yes | All listed constraints | Immutable receipt naming exact transforms, effective options and tool versions. | |
format |
Yes | string | Declared audio container/sample format. | |
sample_rate_hz |
Yes | integer | Prepared audio sample rate in hertz. | |
channel_count |
Yes | integer | Number of channels in the prepared audio. | |
duration_us |
Yes | integer | Prepared audio duration in integer microseconds. |
Definition: preparedAudio.audio_artifact
Immutable extracted/prepared audio bytes.
All of the following constraints apply:
Definition: preparedAudio.audio_artifact: Alternative 1
Immutable extracted/prepared audio bytes.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: preparedAudio.audio_artifact: Alternative 2
Value: object.
Required fields: sha256, byte_length.
Definition: preparedAudio.time_map_artifact
Immutable mapping from prepared audio intervals to original-source intervals.
All of the following constraints apply:
Definition: preparedAudio.time_map_artifact: Alternative 1
Immutable mapping from prepared audio intervals to original-source intervals.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: preparedAudio.time_map_artifact: Alternative 2
Value: object.
Required fields: sha256, byte_length.
Definition: preparedAudio.transform_artifact
Immutable receipt naming exact transforms, effective options and tool versions.
All of the following constraints apply:
Definition: preparedAudio.transform_artifact: Alternative 1
Immutable receipt naming exact transforms, effective options and tool versions.
Value: Reference: common.schema.json#/$defs/artifactReference.
Definition: preparedAudio.transform_artifact: Alternative 2
Value: object.
Required fields: sha256, byte_length.
Definition: segment
Reference to current embedded subtitle/speaker evidence. Timings, attribution payloads and known-person assignments are resolved from the current recording and mapping; they are not copied here.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable segment reference identity. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Immutable reference revision. | |
recording_id |
Yes | Reference: common.schema.json#/$defs/uuid | Current recording owning the embedded Cueson evidence. | |
document_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Exact current embedded document digest; stale references fail resolution. | |
cue_id |
Yes | string | Cue identity inside the current embedded document. | |
local_speaker_id |
Yes | Reference: common.schema.json#/$defs/localSpeakerID | Recording-scoped local speaker token occurring in this cue attribution. | |
clip_artifact_id |
Yes | At least one alternative | Optional derived clip identity, or null. A clip does not become assignment authority. |
Definition: segment.clip_artifact_id
Optional derived clip identity, or null. A clip does not become assignment authority.
At least one of the following alternatives must match:
Definition: segment.clip_artifact_id: Alternative 1
Optional managed prepared clip identity.
Value: Reference: common.schema.json#/$defs/uuid.
Definition: segment.clip_artifact_id: Alternative 2
Value: null.
Example
{
"schema_version": "1.0.0",
"kind": "speaker-segments",
"workspace_id": "00000000-0000-4000-8000-00000000000a",
"catalog_revision": 1,
"generated_at": {
"iso": "2026-10-04T20:00:00Z",
"unix_ns": 1791144000000000000
},
"speaker_filter": "00000000-0000-4000-8000-000000000006",
"segments": [
{
"id": "00000000-0000-4000-8000-000000000001",
"revision": 1,
"recording_id": "00000000-0000-4000-8000-000000000002",
"document_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"cue_id": "cue-000000",
"local_speaker_id": "00000000-0000-4000-8000-000000000003",
"clip_artifact_id": null
}
],
"next_cursor": null
}
Portable workspace backup
Completed portable authority bundle with consistent catalog proof, current immutable byte inventory and explicit retention dependencies. Runtime validates digests, relations and store availability in addition to this structural contract.
Download workspace-backup.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "workspace-backup" | Portable workspace backup discriminator. | |
schema_version |
Yes | Constant "1.0.0" | Synchronized software/documentation/schema release. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Backup identity and persistent retention owner. | |
mode |
Yes | "self-contained", "reference-only" | Copied immutable bytes or explicit original-store dependency. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Source authority workspace, adopted only after validated restoration. | |
catalog_revision |
Yes | integer | Consistent exact snapshot revision. | |
catalog_digest |
Yes | string | Validated logical catalog snapshot digest. | |
catalog_sha256 |
Yes | string | SHA-256 of exact catalog.json bytes. | |
workspace |
Yes | Reference: workspace-config.schema.json | Nonsecret source configuration; destination access is configured separately. | |
source_profiles |
Yes | array | Exact nonsecret storage profiles needed by retained source identities. | |
artifacts |
Yes | array | Complete current/durable authority inventory; transient and superseded bytes are excluded. | |
graph_disposition |
Yes | Constant "accepted-evidence-rebuild" | Destination graph rebuilds from accepted catalog evidence; imported checkpoints never assert currency. | |
dependency |
Yes | string | Explicit original-store dependency for reference-only mode, otherwise none. | |
sha256 |
Yes | string | Manifest SHA-256 with this field set to an empty string during canonical calculation. | |
source_catalog_revision |
Yes | integer | Exact source capture revision before proof-backed portable sanitization. | |
source_catalog_digest |
Yes | Reference: common.schema.json#/$defs/sha256 | Untouched source snapshot digest; portable catalog_digest may differ when incomplete local acquisition input is replaced by an explicit interrupted-input marker. |
source_profiles
Exact nonsecret storage profiles needed by retained source identities.
Value: array.
source_profiles[]
Value: Reference: workspace-config.schema.json#/properties/profiles/properties/storage.
artifacts
Complete current/durable authority inventory; transient and superseded bytes are excluded.
Value: array.
artifacts[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
publication |
Yes | object | Immutable receipt-backed source publication authority. | |
file |
No | string | Digest-addressed byte file, required only for self-contained mode. |
artifacts[].publication
Immutable receipt-backed source publication authority.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable id in immutable publication history. | |
artifact_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable artifact id in immutable publication history. | |
location_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable location id in immutable publication history. | |
profile_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable profile id in immutable publication history. | |
owner |
Yes | Reference: common.schema.json#/$defs/uuid | Stable owner in immutable publication history. | |
admission_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable admission id in immutable publication history. | |
journal_receipt_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable journal receipt id in immutable publication history. | |
profile_revision |
Yes | integer | Exact profile revision. | |
generation |
Yes | integer | Exact generation. | |
size |
Yes | integer | Exact size; availability and lease clocks are integer nanoseconds. | |
part_size |
Yes | integer | Exact part size; availability and lease clocks are integer nanoseconds. | |
lease_until |
Yes | integer | Exact lease until; availability and lease clocks are integer nanoseconds. | |
available_at |
Yes | integer | Exact available at; availability and lease clocks are integer nanoseconds. | |
digest |
Yes | string | SHA-256 of immutable artifact bytes. | |
kind |
Yes | string | Recorded kind. The key/version identifies source-store bytes, not a local input path. | |
key |
Yes | string | Recorded key. The key/version identifies source-store bytes, not a local input path. | |
version |
Yes | string | Recorded version. The key/version identifies source-store bytes, not a local input path. | |
verification |
Yes | string | Recorded verification. The key/version identifies source-store bytes, not a local input path. | |
upload_id |
Yes | string | Recorded upload id. The key/version identifies source-store bytes, not a local input path. | |
state |
Yes | string | Recorded state. The key/version identifies source-store bytes, not a local input path. | |
completion_requested |
Yes | boolean | Recorded immutable publication completion intent. | |
parts |
Yes | array | Historical multipart transport receipts. | |
references |
Yes | object | Persistent catalog retention references, including explicit backup lifetime ownership. | |
leases |
Yes | object | Historical leases, expired on restoration. | |
events |
Yes | array | Publication lifecycle event identities. |
artifacts[].publication.parts
Historical multipart transport receipts.
Value: array.
artifacts[].publication.parts[]
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
number |
Yes | integer | One-based upload part. | |
etag |
Yes | string | Provider transport receipt, not a content digest. | |
size |
Yes | integer | Exact part byte count. |
artifacts[].publication.references
Persistent catalog retention references, including explicit backup lifetime ownership.
Value: object.
artifacts[].publication.references{name}
Value: Constant true.
artifacts[].publication.leases
Historical leases, expired on restoration.
Value: object.
artifacts[].publication.leases{name}
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Materialization lease identity. | |
owner |
Yes | Reference: common.schema.json#/$defs/uuid | Lease owner. | |
generation |
Yes | integer | Fenced lease generation. | |
until |
Yes | integer | Expiry in integer nanoseconds. | |
released |
Yes | boolean | Explicit release disposition. |
artifacts[].publication.events
Publication lifecycle event identities.
Value: array.
artifacts[].publication.events[]
Value: string.
All of the following constraints apply:
When mode is "self-contained":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifacts |
No | array | Artifact file-presence requirements for the selected backup mode. |
artifacts
Artifact file-presence requirements for the selected backup mode.
Value: array.
artifacts[]
Value: object.
Required fields: file.
When mode is "reference-only":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifacts |
No | array | Artifact file-presence requirements for the selected backup mode. |
artifacts
Artifact file-presence requirements for the selected backup mode.
Value: array.
artifacts[]
Value: object.
Disallowed combination: has file.
Example
{
"kind": "workspace-backup",
"schema_version": "1.0.0",
"id": "00000000-0000-4000-8000-000000000001",
"mode": "self-contained",
"workspace_id": "00000000-0000-4000-8000-000000000002",
"catalog_revision": 0,
"catalog_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"catalog_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"workspace": {
"schema_version": "1.0.0",
"kind": "workspace-config",
"workspace_id": "00000000-0000-4000-8000-000000000002",
"display_name": "My library",
"control_directory": "/home/user/MediaLibrary",
"default_import_timezone": "local",
"profiles": {
"storage": {
"profile_id": "33333333-3333-4333-8333-333333333333",
"profile_revision": 1,
"adapter_id": "filesystem",
"contract_version": "1",
"configuration": {
"root": "objects"
}
},
"catalog": {
"profile_id": "44444444-4444-4444-8444-444444444444",
"profile_revision": 1,
"adapter_id": "sqlite",
"contract_version": "1",
"configuration": {
"path": "catalog.sqlite"
}
},
"graph": {
"profile_id": "55555555-5555-4555-8555-555555555555",
"profile_revision": 1,
"adapter_id": "ladybugdb",
"contract_version": "1",
"configuration": {
"path": "graph/library.lbug"
}
}
}
},
"source_profiles": [],
"artifacts": [],
"graph_disposition": "accepted-evidence-rebuild",
"dependency": "none",
"sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
"source_catalog_revision": 0,
"source_catalog_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
insonic workspace configuration
Versioned nonsecret configuration selecting artifact, catalog and graph adapters independently. Filesystem/SQLite/LadybugDB are defaults, while S3/PostgreSQL/ArcadeDB have full planned application support.
Download workspace-config.schema.json
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
schema_version |
Yes | Constant "1.0.0" | Version of this public insonic contract. | |
kind |
Yes | Constant "workspace-config" | Document discriminator selected by the master registry. | |
workspace_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable workspace scope used by all domain records. | |
display_name |
Yes | string | User-facing workspace name. | |
control_directory |
Yes | string | Selected local directory for control files, scratch and caches even when authority is remote. | |
profiles |
Yes | object | Three independent required backend selections. | |
default_import_timezone |
No | Reference: common.schema.json#/$defs/timezone | Default timezone captured when creating an import batch. | |
extensions |
No | Reference: common.schema.json#/$defs/extensions | Optional namespaced nonsecret extension data. | |
credential_namespace_id |
No | Reference: common.schema.json#/$defs/uuid | Optional nonsecret local credential-store namespace, defaulting to workspace_id. Restore preserves the independently configured destination namespace when adopting source catalog identity; it never copies credential values. |
profiles
Three independent required backend selections.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
storage |
Yes | object | Selected artifact storage profile with an immutable configuration revision. | |
catalog |
Yes | object | Selected operational catalog profile with an immutable configuration revision. | |
graph |
Yes | object | Selected graph projection profile with an immutable configuration revision. |
profiles.storage
Selected artifact storage profile with an immutable configuration revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
profile_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable configured profile identity. | |
profile_revision |
Yes | Reference: common.schema.json#/$defs/revision | Selected profile configuration revision. | |
adapter_id |
Yes | "filesystem", "s3" | Backend adapter selected for this role. | |
contract_version |
Yes | string | Versioned insonic adapter contract. | |
configuration |
Yes | Exactly one alternative | Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape. | |
expected_backend_version |
No | string | Optional tested backend version constraint; health/capability checks verify it before use. |
profiles.storage.configuration
Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape.
Exactly one of the following alternatives must match:
profiles.storage.configuration: Alternative 1
Default local filesystem artifact store. The root is a selected location, not a source identity.
Value: Reference: #/$defs/filesystemConfiguration.
profiles.storage.configuration: Alternative 2
Generic S3 API configuration, applicable to remote providers and user-run filesystem-backed S3 endpoints.
Value: Reference: #/$defs/s3Configuration.
All of the following constraints apply:
When adapter_id is "filesystem":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/filesystemConfiguration | Default local filesystem artifact store. The root is a selected location, not a source identity. |
When adapter_id is "s3":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/s3Configuration | Generic S3 API configuration, applicable to remote providers and user-run filesystem-backed S3 endpoints. |
profiles.catalog
Selected operational catalog profile with an immutable configuration revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
profile_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable configured profile identity. | |
profile_revision |
Yes | Reference: common.schema.json#/$defs/revision | Selected profile configuration revision. | |
adapter_id |
Yes | "sqlite", "postgresql" | Backend adapter selected for this role. | |
contract_version |
Yes | string | Versioned insonic adapter contract. | |
configuration |
Yes | Exactly one alternative | Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape. | |
expected_backend_version |
No | string | Optional tested backend version constraint; health/capability checks verify it before use. |
profiles.catalog.configuration
Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape.
Exactly one of the following alternatives must match:
profiles.catalog.configuration: Alternative 1
Default local SQLite catalog configuration.
Value: Reference: #/$defs/sqliteConfiguration.
profiles.catalog.configuration: Alternative 2
Full PostgreSQL catalog configuration. Credentials remain outside this document and application transactions retain workspace scope.
Value: Reference: #/$defs/postgresqlConfiguration.
All of the following constraints apply:
When adapter_id is "sqlite":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/sqliteConfiguration | Default local SQLite catalog configuration. |
When adapter_id is "postgresql":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/postgresqlConfiguration | Full PostgreSQL catalog configuration. Credentials remain outside this document and application transactions retain workspace scope. |
profiles.graph
Selected graph projection profile with an immutable configuration revision.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
profile_id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable configured profile identity. | |
profile_revision |
Yes | Reference: common.schema.json#/$defs/revision | Selected profile configuration revision. | |
adapter_id |
Yes | "ladybugdb", "arcadedb", "community" | Backend adapter selected for this role. | |
contract_version |
Yes | string | Versioned insonic adapter contract. | |
configuration |
Yes | Exactly one alternative | Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape. | |
expected_backend_version |
No | string | Optional tested backend version constraint; health/capability checks verify it before use. |
profiles.graph.configuration
Nonsecret adapter configuration matching adapter_id; conditional rules identify the exact permitted shape.
Exactly one of the following alternatives must match:
profiles.graph.configuration: Alternative 1
Default embedded LadybugDB projection attached to the owning runtime.
Value: Reference: #/$defs/ladybugdbConfiguration.
profiles.graph.configuration: Alternative 2
ArcadeDB server graph adapter configuration, distinct from the operational catalog role.
Value: Reference: #/$defs/arcadedbConfiguration.
profiles.graph.configuration: Alternative 3
Optional user-provided graph adapter configuration. This does not make its engine officially supported or redistributed.
Value: Reference: #/$defs/communityConfiguration.
All of the following constraints apply:
When adapter_id is "ladybugdb":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/ladybugdbConfiguration | Default embedded LadybugDB projection attached to the owning runtime. |
When adapter_id is "arcadedb":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/arcadedbConfiguration | ArcadeDB server graph adapter configuration, distinct from the operational catalog role. |
When adapter_id is "community":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
configuration |
No | Reference: #/$defs/communityConfiguration | Optional user-provided graph adapter configuration. This does not make its engine officially supported or redistributed. |
filesystem configuration
Default local filesystem artifact store. The root is a selected location, not a source identity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
root |
Yes | string | Managed local artifact root; installation directories and disposable caches are not durable storage. | "/home/user/MediaLibrary/objects" |
s3 configuration
Generic S3 API configuration, applicable to remote providers and user-run filesystem-backed S3 endpoints.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
endpoint |
Yes | Reference: common.schema.json#/$defs/endpoint | Selected S3 service endpoint without credentials in its URL. | |
bucket |
Yes | string | Existing or explicitly created bucket used by this workspace. | "media-library" |
prefix |
No | string | Workspace-managed object-key prefix; empty is allowed. | "insonic/" |
region |
Yes | string | Region/signing value required by this provider. | "us-east-1" |
addressing_style |
Yes | "auto", "path", "virtual" | S3 bucket addressing mode qualified for this endpoint. | |
authentication |
Yes | "credential", "environment", "anonymous" | Explicit credential resolution mode; environment uses a selected runtime credential chain, not exported secret values. | |
credential_id |
No | Reference: common.schema.json#/$defs/credentialId | Opaque credential reference required for credential mode. |
All of the following constraints apply:
When authentication is "credential":
Value: object.
Required fields: credential_id.
sqlite configuration
Default local SQLite catalog configuration.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Local catalog file path on a supported filesystem; not an S3 object or network-shared live file. | "catalog.sqlite" |
postgresql configuration
Full PostgreSQL catalog configuration. Credentials remain outside this document and application transactions retain workspace scope.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
host |
Yes | string | PostgreSQL hostname or explicitly selected local transport location. | "db.example.com" |
port |
Yes | integer | PostgreSQL service port. | 5432 |
database |
Yes | string | Configured database containing the catalog. | |
schema |
Yes | string | Dedicated catalog schema namespace. | "insonic" |
tls_mode |
Yes | "verify-full", "local" | verify-full verifies the remote server certificate and hostname; local is an explicit local transport configuration. | |
ca_file |
No | string | Optional local CA certificate path for verified TLS. | |
credential_id |
No | Reference: common.schema.json#/$defs/credentialId | Opaque PostgreSQL authentication reference when credentials are required. |
ladybugdb configuration
Default embedded LadybugDB projection attached to the owning runtime.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
path |
Yes | string | Local graph directory/file location; never a live object-store database. | "graph/library.lbug" |
arcadedb configuration
ArcadeDB server graph adapter configuration, distinct from the operational catalog role.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
endpoint |
Yes | Reference: common.schema.json#/$defs/endpoint | Configured ArcadeDB HTTP service endpoint. | |
database |
Yes | string | Selected ArcadeDB database for this workspace graph. | |
credential_id |
No | Reference: common.schema.json#/$defs/credentialId | Opaque service credential reference resolved by the runtime. | |
preferred_dialect |
No | "arcade-opencypher", "arcade-sql" | Requested native query dialect, qualified against the actual server capabilities. |
community configuration
Optional user-provided graph adapter configuration. This does not make its engine officially supported or redistributed.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
plugin_id |
Yes | string | User-selected adapter extension identity. | |
contract_version |
Yes | string | Versioned graph adapter contract implemented by the extension. | |
options |
Yes | Reference: common.schema.json#/$defs/nonsecretOptions | Plugin options validated by its declared configuration contract. | |
credential_id |
No | Reference: common.schema.json#/$defs/credentialId | Optional opaque credential reference for this extension. |
Example
{
"schema_version": "1.0.0",
"kind": "workspace-config",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"display_name": "My library",
"control_directory": "/home/user/MediaLibrary",
"default_import_timezone": "local",
"profiles": {
"storage": {
"profile_id": "33333333-3333-4333-8333-333333333333",
"profile_revision": 1,
"adapter_id": "filesystem",
"contract_version": "1",
"configuration": {
"root": "objects"
}
},
"catalog": {
"profile_id": "44444444-4444-4444-8444-444444444444",
"profile_revision": 1,
"adapter_id": "sqlite",
"contract_version": "1",
"configuration": {
"path": "catalog.sqlite"
}
},
"graph": {
"profile_id": "55555555-5555-4555-8555-555555555555",
"profile_revision": 1,
"adapter_id": "ladybugdb",
"contract_version": "1",
"configuration": {
"path": "graph/library.lbug"
}
}
}
}
Shared definitions
Shared logical types for the v1.0.0 contract. This resource defines reusable values and is not a standalone application document envelope. Format annotations require a format-aware validator; semantic comparisons and timezone resolution remain application validation.
Definition: uuid
Stable application-generated UUID identity. UUIDs identify logical records, not database row IDs or filesystem locations.
Value: string.
Example:
"11111111-1111-4111-8111-111111111111"
Definition: sha256
Lowercase SHA-256 digest of the complete immutable byte sequence. Provider ETags and multipart/composite checksums are not this digest.
Value: string.
Example:
"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
Definition: revision
Monotonically increasing logical revision within one entity or ordered revision stream. Expected-revision checks prevent lost updates; database-native sequences are not exposed as identity.
Value: integer.
Example:
1
Cueson-compatible timestamp
Absolute instant in Cueson's timestamp format: RFC 3339 text and Unix nanoseconds representing the same instant. The application verifies agreement and preserves integer precision; import wall-time literals and media-relative intervals use distinct types.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
iso |
Yes | string | RFC 3339 representation of the instant, including its UTC offset and available fractional-second precision. Audit output uses UTC. | "2026-10-04T18:30:00.123456Z"; "1970-01-01T00:00:00.123456789Z" |
unix_ns |
Yes | integer | Nanoseconds since the Unix epoch for the same instant as iso. Parse and serialize this integer without floating-point rounding; JSON Schema validation alone does not verify agreement with iso. | 123456789 |
Example:
{
"iso": "1970-01-01T00:00:00.123456789Z",
"unix_ns": 123456789
}
Definition: calendarDate
Calendar date with day precision, formatted YYYY-MM-DD. A date does not assert a known recording time.
Value: string.
Example:
"2026-10-04"
Definition: wallTimestamp
Entered timestamp literal with seconds and up to nanosecond precision, Z or numeric offset. Without a zone, the captured import timezone policy applies. Calendar validity, DST folds/gaps and zone-offset agreement require application validation.
Value: string.
Example:
"2026-10-04T14:30:00"
Example:
"2026-10-04T18:30:00Z"
Definition: timezone
Timezone selector: local, UTC, an IANA identifier or a numeric offset. This pattern validates shape, not IANA membership. Resolve local once and persist its actual interpretation.
Value: string.
Example:
"local"
Example:
"UTC"
Example:
"America/New_York"
Example:
"+02:00"
Definition: mediaInterval
Positive-duration, half-open original-media interval in integer microseconds. The application must additionally validate end_us > start_us and probed-duration/codec tolerance.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
start_us |
Yes | integer | Inclusive interval start on the original media clock in microseconds. | 0 |
end_us |
Yes | integer | Exclusive interval end on the same original clock in microseconds. | 1250000 |
Example:
{
"start_us": 0,
"end_us": 1250000
}
Definition: artifactReference
Portable reference to an immutable logical artifact. Digest and size can accompany the stable ID when available; location/materialization and access credentials belong to separate runtime records.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
artifact_id |
Yes | Reference: #/$defs/uuid | Stable catalog artifact ID, independent of object key or local cache path. | |
sha256 |
No | Reference: #/$defs/sha256 | Expected complete-content digest when the caller has verified bytes. | |
byte_length |
No | integer | Expected length of the complete content in bytes, including zero-length nonmedia artifacts. | 4096 |
extensions |
No | Reference: #/$defs/extensions | Optional namespaced reference annotations without changing identity. |
Example:
{
"artifact_id": "22222222-2222-4222-8222-222222222222",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"byte_length": 4096
}
Definition: backendProfileReference
Reference to a selected versioned backend profile. Profile records hold configuration and opaque credential references; application documents do not embed credentials.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
profile_id |
Yes | Reference: #/$defs/uuid | Stable configured backend profile ID. | |
profile_revision |
Yes | Reference: #/$defs/revision | Selected immutable profile revision. | |
adapter_id |
No | string | Adapter identity used to interpret the referenced profile. | "filesystem" |
contract_version |
No | string | Version of the adapter contract selected for this profile. | "1" |
Example:
{
"profile_id": "33333333-3333-4333-8333-333333333333",
"profile_revision": 1,
"adapter_id": "filesystem",
"contract_version": "1"
}
Definition: credentialId
Opaque credential ID resolved by SecretStore. This field never contains a password, API key, session token or secret-bearing connection URL.
Value: string.
Example:
"11111111-1111-4111-8111-111111111111"
Definition: endpoint
Configured HTTP(S) service endpoint without URL user information, query tokens or fragments. Local HTTP is permitted explicitly; service credentials are separate opaque references.
Value: string.
Example:
"https://objects.example.com"
Example:
"http://127.0.0.1:2480"
Definition: nonsecretOptions
Adapter-specific, versioned options validated further against that adapter's capability/configuration schema. These properties are intentionally extensible and must not contain credential values.
Value: object.
Example:
{
"sample_rate": 16000,
"device": "cpu"
}
Definition: extensions
Optional namespaced extension data. Core consumers may preserve unknown extensions without interpreting them. Extensions must not redefine required fields, hide credentials or mutate immutable provenance.
Value: object.
Example:
{
"example.org/note": "Optional annotation"
}
Consumer speaker identifier
Exact bounded recording-local speaker token. It is not a global person identity.
Value: string.
Example:
"Alex"
Example:
"f7746aa9-d48c-49ba-9f26-9c30219b1029"
Example:
"日本語"
Example:
"é"
Example:
"🙂"
All of the following constraints apply:
Consumer speaker identifier: Alternative 1
Consumer speaker identifier: Alternative 2
Consumer speaker identifier: Alternative 3
Definition: modelAliasName
Case-sensitive lowercase workspace shorthand.
Value: string.
Disallowed combination: the condition matches.
Definition: modelReference
Lowercase alias, exact UUID, typed base/speaker UUID or explicitly configured source:NAME/SELECTOR. Submission freezes its immutable target.
Value: string.
Disallowed combination: the condition matches.
Definition: modelOperation
Declared intended operation. Declaration does not establish an executable adapter.
Value: "transcription", "diarization", "voice-matching", "speaker-model-training".
Definition: modelTarget
Typed exact target; base and speaker identities remain separate from hosted handles.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | "base", "speaker", "hosted" | Exact base installation, trained speaker version or hosted-only provider handle. | |
id |
No | Reference: common.schema.json#/$defs/uuid | Exact installation or speaker-version identity. | |
operation |
Yes | Reference: common.schema.json#/$defs/modelOperation | Declared operation. | |
adapter |
No | string | Selected adapter identity. | |
contract_version |
No | string | Adapter contract version. | |
endpoint |
No | string | Hosted endpoint without credential-bearing URL data. | |
remote_model |
No | string | Exact hosted provider handle. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Opaque credential routing reference. | |
upstream_revision |
No | string | Exact upstream revision or declared provider identity. |
All of the following constraints apply:
When kind matches "base", "speaker":
Required fields: id.
Disallowed combination: the condition matches.
When kind is "hosted":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | Constant "insonic-http" | Implemented hosted adapter identity. | |
contract_version |
Yes | Constant "1" | Implemented hosted contract version. |
Disallowed combination: has id.
Definition: modelCompatibility
Optional explicit compatibility; unsupported declarations remain inspectable and cannot execute.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
adapter |
Yes | string | Compatible adapter contract identity. | |
contract_version |
Yes | string | Compatible adapter contract version. | |
architecture |
Yes | string | Declared model architecture. | |
runtime_format |
Yes | string | Declared loader/runtime format. | |
sample_rates |
No | array | Supported sample rates where declared. | |
channels |
No | array | Supported channel counts where declared. |
Definition: modelCompatibility.sample_rates
Supported sample rates where declared.
Value: array.
Definition: modelCompatibility.sample_rates[]
Compatible input sample rate in hertz.
Value: integer.
Definition: modelCompatibility.channels
Supported channel counts where declared.
Value: array.
Definition: modelCompatibility.channels[]
Compatible input channel count.
Value: integer.
Definition: modelAlias
Portable revisioned alias retaining exact target kind and identity.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable workspace-scoped alias identity. | |
name |
Yes | Reference: common.schema.json#/$defs/modelAliasName | Short workspace name. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Concurrent-edit fencing revision. | |
state |
Yes | "active", "deleted" | Active reference or retained revision tombstone. | |
target |
Yes | Reference: common.schema.json#/$defs/modelTarget | Exact target; retargeting never changes prior elections. |
Definition: modelSource
Portable source configuration without credential values.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
id |
Yes | Reference: common.schema.json#/$defs/uuid | Stable configured source identity. | |
name |
Yes | Reference: common.schema.json#/$defs/modelAliasName | Configured source name used by source:NAME/SELECTOR. | |
revision |
Yes | Reference: common.schema.json#/$defs/revision | Concurrent-edit fencing revision. | |
state |
Yes | "active", "deleted" | Active configuration or retained revision tombstone. | |
url |
Yes | string | Configured catalog URL using HTTPS or explicitly elected loopback HTTP. | |
credential_id |
No | Reference: common.schema.json#/$defs/uuid | Opaque source credential reference. | |
local_http |
No | boolean | Permit HTTP only for an explicitly selected loopback catalog. |
Definition: modelResolution
Frozen exact selection or nonexecuting inspection response, retaining source/alias revisions.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
reference |
Yes | Reference: common.schema.json#/$defs/modelReference | Original selector retained with the exact election. | |
target |
Yes | Exactly one alternative | Exact consumer selection, operation-neutral acquisition selection or explicitly unresolved missing diagnosis. | |
manifest |
No | Reference: base-model-manifest.schema.json | Exact complete pinned base bundle when applicable. | |
manifest_digest |
Yes | string | Immutable manifest digest, empty only when a trained descriptor has no manifest artifact or a missing reference has no resolved manifest. | |
upstream_revision |
Yes | string | Declared immutable upstream revision, or empty when unavailable. | |
state |
Yes | "registered", "available", "discovered", "hosted-only", "current", "invalidated", "missing" | Registry or exact target state, or missing when inspection could not establish a valid selection; acquisition/inference state belongs to durable work. | |
alias_id |
No | Reference: common.schema.json#/$defs/uuid | Resolved alias identity when applicable. | |
alias_revision |
No | Reference: common.schema.json#/$defs/revision | Alias revision frozen at election. | |
source_id |
No | Reference: common.schema.json#/$defs/uuid | Explicit source identity when applicable. | |
source_revision |
No | Reference: common.schema.json#/$defs/revision | Source revision frozen at election. | |
compatible |
Yes | boolean | Whether a consumer accepts the target for its operation. Operation-neutral acquisition instead reports accepted bundle metadata; it does not assert inference compatibility. Missing selections are always false. | |
diagnostics |
Yes | array | Separate diagnoses; compatibility does not claim acoustic qualification. | |
lineage |
No | object | Trained version family/run/dataset/artifact/current-association lineage. |
Definition: modelResolution.target
Exact consumer selection, operation-neutral acquisition selection or explicitly unresolved missing diagnosis.
Exactly one of the following alternatives must match:
Definition: modelResolution.target: Alternative 1
Operation-specific exact target.
Value: Reference: common.schema.json#/$defs/modelTarget.
Definition: modelResolution.target: Alternative 2
Explicit bundle-acquisition target without an inference election.
Value: Reference: common.schema.json#/$defs/modelAcquisitionTarget.
Definition: modelResolution.target: Alternative 3
Missing consumer reference diagnosis without an invented identity.
Value: Reference: common.schema.json#/$defs/modelUnresolvedTarget.
Definition: modelResolution.diagnostics
Separate diagnoses; compatibility does not claim acoustic qualification.
Value: array.
Definition: modelResolution.diagnostics[]
Actionable compatibility/availability diagnosis without credential values.
Value: string.
Definition: modelResolution.lineage
Trained version family/run/dataset/artifact/current-association lineage.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
version |
Yes | Reference: catalog-snapshot.schema.json#/properties/records/properties/versions/items | Exact originating version record. | |
model |
Yes | Reference: catalog-snapshot.schema.json#/properties/records/properties/models/items | Exact originating model record. | |
run |
Yes | Reference: catalog-snapshot.schema.json#/properties/records/properties/runs/items | Exact originating run record. | |
dataset |
Yes | Reference: catalog-snapshot.schema.json#/properties/records/properties/datasets/items | Exact originating dataset record. | |
artifacts |
Yes | array or null | Origin and current association records; no synthesized training output. | |
associations |
Yes | array or null | Origin and current association records; no synthesized training output. |
Definition: modelResolution.lineage.artifacts
Origin and current association records; no synthesized training output.
Value: array or null.
Definition: modelResolution.lineage.artifacts[]
Value: Reference: catalog-snapshot.schema.json#/properties/records/properties/model_artifacts/items.
Definition: modelResolution.lineage.associations
Origin and current association records; no synthesized training output.
Value: array or null.
Definition: modelResolution.lineage.associations[]
Value: Reference: catalog-snapshot.schema.json#/properties/records/properties/model_associations/items.
All of the following constraints apply:
When target matches object:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
reference |
No | string | Explicit immutable base installation selected from the complete manifest. | |
state |
No | "registered", "available", "discovered" | Known immutable base-bundle registry state. | |
manifest_digest |
No | Reference: common.schema.json#/$defs/sha256 | Exact complete immutable bundle manifest digest. | |
upstream_revision |
No | string | Pinned nonempty upstream revision. | |
compatible |
No | Constant true | Bundle metadata accepted for acquisition, without an inference operation. |
When target matches object:
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
state |
No | Constant "missing" | Unresolved references only occur in missing-selection diagnostics. |
When state is "missing":
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
compatible |
No | Constant false | Missing selections cannot claim consumer compatibility. | |
manifest_digest |
No | Constant "" | No manifest was resolved. | |
upstream_revision |
No | Constant "" | No upstream revision was resolved. |
Disallowed combination: the condition matches.
Definition: modelAcquisitionTarget
Response-only operation-neutral acquisition target. Alias and processing targets retain their strict operation-specific contract.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "base" | An immutable base bundle selected for acquisition only. | |
id |
Yes | Reference: common.schema.json#/$defs/uuid | Exact immutable base installation identity. | |
operation |
Yes | Constant "" | No inference operation is elected by direct bundle acquisition. |
Definition: modelUnresolvedTarget
Response-only missing-selection diagnosis. It never fabricates a model ID or authorizes execution.
| Field | Required | Value | Description | Examples |
|---|---|---|---|---|
kind |
Yes | Constant "unresolved" | The reference could not establish an exact valid consumer election. | |
operation |
Yes | Reference: common.schema.json#/$defs/modelOperation | Intended stage operation retained with the unavailable reference. |