Skip to content

Documentation

The technical reference for the API. The tutorials show how it is used in practice; here you find all endpoints, parameters, fields and rules.

Basics
Address https://api.nasjonalmuseet.no
Version /api/v1 (see Stability)
Format JSON, UTF-8. Linked Art as JSON-LD
Key The X-API-Key header
Language lang=no or lang=en
Running version GET /api/health

Endpoints

Every request can be tried in Swagger.

Endpoint Level Description
GET /api/v1/objects/{nmId} pub One work
GET /api/v1/objects pub Browse the collection
GET /api/v1/objects/text-search pub Search for words in the catalogue
GET /api/v1/objects/{nmId}/multimedia pub The work's images
GET /api/v1/iiif/manifest/{nmId}.json open IIIF manifest
GET /api/linkedart/object/{id} open Linked Art: work
GET /api/linkedart/object/text-search open Linked Art: search
GET /api/v1/objects/linkedart/{nmId} pub Linked Art by inventory number
POST /api/v1/search/interpret pub Suggested search text and filters
POST /api/v1/search/semantic ext Semantic search
POST /api/v1/search/filter ext Filtering
POST /api/v1/search/similar/{imageId} ext Similar images
POST /api/v1/search/explain ext Why an image matched
GET /api/health open Status and version

More