DEVELOPER REFERENCE

A small, read-only public interface.

This public interface is read-only. No user-account, write or recommendation API is currently provided, and no service-level agreement is implied. Datasets, schemas, identifiers, provenance, citation, rights, downloads, releases and methodology are open; private ranking weights and personal data are never part of it.

SCHEMA VERSION1.0

INVENTORIED RESOURCES165

AUTHNone for public reads

DISCOVERY5

/.well-known/smellbook.json

Discovery document

Canonical machine entry point.

JSON ↗

/data/routes.json

Route index

Public machine and documentation routes.

JSON ↗

/data/contract.json

Compatibility contract

Guarantees, exclusions and versioning rules.

JSON ↗

/data/schema.json

Schema registry

Record-level JSON Schema definitions.

JSON ↗

/data/inventory.json

Data inventory

Formats, media types and record counts.

JSON ↗

What the discovery document lists

Start here. Developer guide, Documentation map, Read-only API reference, Consumer guide. 6 machine files.
Public datasets. Public data, Data inventory, Entity records, Relations, Facets, Vocabulary, Search data, For institutions. 31 machine files.
Schemas. Schemas, Data dictionary, Schema examples, Formats. 5 machine files.
Identifiers. Identifiers, Referencing SmellBook identifiers, Linked data. 5 machine files.
Provenance. Provenance, Provenance chains, Dataset lineage, Editorial provenance, Source lifecycle. 8 machine files.
Citation. How to cite SmellBook. 8 machine files.
Rights and privacy. Rights, Privacy, Retention, Data minimisation, Accessibility. 7 machine files.
Downloads. Downloads, Dataset package. 6 machine files.
Releases and archive. Dataset releases, Archive, Snapshot changes, Record fingerprints, Changelog. 9 machine files.
Methodology. Methodology, Evidence, Historical evidence, Evidence coverage, Evidence recency, Record quality, Atlas quality baseline, Capabilities. 6 machine files.
Guarantees and limits. Stability, Deprecations, HTTP behaviour, Caching, Ordering, Query parameters, Canonical addresses, Resource registry. 8 machine files.

Pages retired from the public surface are listed with their dates on Deprecations.

NON-GOALS

No user, write or recommendation API is being implied.

This public interface is read-only. No user-account, write or recommendation API is currently provided, and no service-level agreement is implied. No write API, user account API or recommendation API is live.