How-to guides · Getting one task done
Read the directory by machine
From the root pointer to the manifest in two hops, and how to check liveness before you call.
On this page
Machine access is the primary access: everything sits language-neutral at the root of openhelvetia.swiss. No account, no key, no cookies.
Steps
- Read the root pointer.
GET /.well-known/openhelvetia.json: the association's identity and an objectpointerswith ten pointers, among themdirectory,standard,publish,llms,security. - Fetch the index.
pointers.directoryleads to/directory.json: an envelope withversion,$schema,authorityandentries. - Fetch the manifest when it matters. Every entry row carries the absolute URL of its manifest.
authority = manifestmeans: on any divergence the manifest governs, the index is derived. - Check liveness before you call.
interfaces[].probenames the minimal harmless call (kind) and what counts as an answer (expect); optionallytargetnames a probe URL that differs from the endpoint. The probe kinds are in the reference.
The envelope
{
"$schema": "https://ld.openhelvetia.swiss/ns/directory/0.2/schema",
"authority": "manifest",
"entries": [],
"version": "0.2"
}
This is the envelope without entries; it is valid even then. Today entries carries the association's two own entries. The key order is the one served.
What an entry row carries
slug— registry identifier, also the path under/directory/name,description— language mapspublisher,license— IRIsmanifest— absolute URL of the byte-identical manifest copyinterfaces[]—type,endpoint, optionaltier,docsandprobe
Every surface at the root: Machine surfaces.