Machine-readable definitions

RCAN Schemas

JSON Schema definitions for the core RCAN message types, the RURI format, commitment records, and the full .rcan.yaml config structure. Use these to validate implementations, generate types, and build conformant tooling.

⬇ OpenAPI 3.1 Spec View on GitHub →

Message Schemas

One JSON Schema file for each message type listed here (not every type in the canonical table has one yet). All use $schema: draft-07, include realistic examples, and enforce additionalProperties: false.

Type #	Name	Description	Download
1	COMMAND	Robot command with action, scope, parameters, priority, and session token	command.json
5	CONFIG	Configuration patch message; minimum role level 4 (OWNER) enforced	config.json
3	STATUS	Robot status report with state, battery, and telemetry sub-object	status.json
7	AUTH	Authentication message carrying session token and expiry	auth.json
4	HEARTBEAT	Keepalive with latency budget declaration	heartbeat.json
6	SAFETY	Highest-priority safety event — STOP, ESTOP, or RESUME	safety.json
45	AUTHORIZE	§16 HiTL — approve or reject a pending AI command (OWNER+ only)	authorize.json
10	PENDING_AUTH	§16 HiTL gate — AI command awaiting human authorization	pending_auth.json
11	INVOKE	§19 Behavior/skill invocation request — skill name, parameters, and session context	invoke.json
12	INVOKE_RESULT	§19 Invocation response — result payload, status, and execution metadata	invoke-result.json
13	INVOKE_CANCEL	§19.4 Best-effort cancellation of an in-flight INVOKE — correlates by cancel_msg_id	invoke-cancel.json
16	TRANSPARENCY	EU AI Act Art. 13 disclosure: AI nature, capabilities, operator identity and contact	transparency.json

Core Schemas

RURI format validation, QuantumLink-Sim commitment records, and the full .rcan.yaml config structure.

RURI

Robot Universal Resource Identifier — regex pattern and structure validation

ruri.json

Commitment Record

QuantumLink-Sim commitment record with classical/quantum/hybrid modes and AI block

commitment.json

RCAN Config (.rcan.yaml)

Full .rcan.yaml configuration file — robot identity, brain, safety, security, messaging

rcan-config.json

Envelope (Appendix C)

Declared physical limits: workspace, motion, force, proximity, sensing, stop and heartbeat. Informative; JSON Schema 2020-12.

envelope.json

Gate decision (Appendix C)

Optional hash-chained audit record of each allow, clamp, reject or stop decision. Informative; JSON Schema 2020-12.

gate-decision.json

Registry API

OpenAPI 3.1 specification for all /api/v1/ endpoints. Import into Swagger UI, Redoc, Stoplight, or any OpenAPI-compatible tool to auto-generate SDKs and client libraries.

registry-api.openapi.yaml

540 lines · 5 endpoints · Full Robot schema with all sub-schemas · Error responses documented

Endpoints: GET /api/v1.json · /api/v1/robots.json · /api/v1/robots/{rrn}.json · /api/v1/ruri/{ruri}.json · /api/v1/verify/{rrn}.json

Download YAML

Usage

🐍 Python (jsonschema)

import json, requests
from jsonschema import validate

schema = requests.get(
  "https://rcan.dev/schemas/messages/command.json"
).json()

msg = {
  "message_type": 1,
  "ruri": "rcan://rcan.dev/acme/arm/abc123",
  "principal_id": "user@example.com",
  "role_level": 2,
  "scope": "arm",
  "action": "move",
  "parameters": {"x": 0.1},
  "timestamp_ms": 1234567890000,
  "message_id": "msg-001",
  "priority": "NORMAL"
}
validate(instance=msg, schema=schema)
print("Valid COMMAND message")

🟨 Node.js (ajv)

import Ajv from 'ajv';
import fetch from 'node-fetch';

const ajv = new Ajv();
const schema = await fetch(
  'https://rcan.dev/schemas/messages/command.json'
).then(r => r.json());

const validate = ajv.compile(schema);
const valid = validate(msg);
if (!valid) console.error(validate.errors);
else console.log('Valid COMMAND message');

← RCAN Spec v1.3 Conformance Suite → API Reference → GitHub →