Use OpenRiC, don't just read about it
Practical how-tos for the three public tools in the OpenRiC ecosystem - the viewer you embed, the capture client you paste a key into, and the reference API you POST to.
Getting started
Zero-to-working in 15 minutes. Read, request a key, write, link, probe, embed, harvest. Start here if OpenRiC is new to you.
Implement a server
From nothing to a server that passes Core Discovery, with a one-file standard-library example, the JSON Schemas and the conformance probe. No Heratio, no account.
Evaluate OpenRiC independently
Test the specification from a signed release alone - checksum, signature, fixtures, a minimal server and the probe - with nothing from Heratio or any AHG server.
Viewer guide
Embed @openric/viewer in your own page, in any framework or none, driving any OpenRiC-conformant server.
Capture guide
Walkthrough of capture.openric.org - connect to a server, mint a key, create entities, link relations.
API client guide
How to call /api/ric/v1/* from curl, Python, JavaScript, or any HTTP-speaking tool. Auth, pagination, errors.
Choosing a triplestore
Fuseki (the reference), Oxigraph, GraphDB, Virtuoso, QLever, and friends. Scale bands, performance notes, when to migrate. OpenRiC is triplestore-agnostic.
Before you dive in
If you haven’t yet, the two-page orientation pieces are Home (what OpenRiC is + live status) and Architecture (where the four public deployments fit and how they talk to each other). Read those first if you’re new.
For evidence that the contract works - an end-to-end use case, one example of every RiC-O type, and labels saying which examples are demonstration data - see Proof of implementation. Live figures are on current status.
Reference material, not step-by-step
These guides assume you want to do something. Reference material for each endpoint or primitive lives in the Spec:
- Full endpoint catalog: Viewing API
- JSON-LD shapes / property tables: Mapping
- Viewer rendering model: Graph Primitives
- Conformance testing: Conformance