Public API Reference

Introduction

The DigitaltMuseum Public API provides access to cultural heritage data from museums in Norway and Sweden. An API key is required; use demo for testing.

Base URL: /

Response Formats: JSON, XML

Search Engine: Apache Solr

Owners

List museums (owners) by country:

/api/owners?country=no&api.key=demo

/api/owners?country=se&api.key=demo

Each owner element includes:

• identifier: Unique ID
• parent (optional): Parent owner ID

Search

Perform Solr-based search:

/api/solr/select?q={query}&wt=json&fq={filters}&api.key=demo

Common parameters:

• q: Standard solr Query string
• image_q: NEW: Search for similar images by image. Search with base64 encoded image.
• image_content_q: NEW: Search content in images by text query. Uses vector embeddings.
• metadata_q: NEW: Search for content within metadata using vector embeddings.
• image_url_q: NEW: Search images like image on url
• similar_image_id: NEW: Search for objects with similar images by uuid
• similar_metadata_id: NEW: Search for objects with similar metadata content by uuid
• wt: Output format
• fq: Filter queries
• start, rows, sort, facet

Fields

Stored Fields (display)

• identifier.id
• identifier.owner
• artifact.uniqueId
• artifact.type
• artifact.pictureCount
• artifact.hasPictures
• artifact.defaultMediaIdentifier
• artifact.publishedDate, artifact.updatedDate
• artifact.ingress.title
• artifact.ingress.producer
• artifact.ingress.producerRole
• artifact.ingress.additionalProducers
• artifact.ingress.production.fromYear
• artifact.ingress.production.toYear
• artifact.ingress.production.place
• artifact.ingress.classification
• artifact.ingress.subjects
• artifact.ingress.license
• artifact.coordinate

Indexed Fields (searchable)

• artifact.name, artifact.title, artifact.classification
• artifact.producer, artifact.depictedPerson, artifact.depictedPlace
• artifact.material, artifact.technique, artifact.license
• artifact.eventDescription, artifact.event.fromYear, artifact.event.toYear, artifact.event.place
• artifact.folderUids, artifact.exhibitionUids, allContent

Examples

Standard legacy solr Free-text search for "ølbolle" in NF and MH:

/api/solr/select?q=%C3%B8lbolle&wt=json&fq=(identifier.owner:NF%20OR%20identifier.owner:MH)&api.key=demo

ML vector search in metadata "hester i vinterlandskap":

/api/solr/select?metadata_q=hester%20i%20vinterlandskap&wt=json&api.key=demo

ML vector search in image content "hester i vinterlandskap":

/api/solr/select?image_content_q=hester%20i%20vinterlandskap&wt=json&api.key=demo

ML vector search similar images from image-url":

/api/solr/select?rows=10&api.key=demo&image_url_q=https%3A%2F%2Fframmuseum.no%2Ffilarkiv%2Fexplorers%2Fno-nb_bldsa_1a011_large.jpg

Objects with images:

/api/solr/select?q=%C3%B8lbolle&wt=json&fq=(identifier.owner:NF%20OR%20identifier.owner:MH)&fq=artifact.hasPictures:true&api.key=demo

Field search for Oslo:

/api/solr/select?q=artifact.event.place:(oslo)&wt=json&api.key=demo

Types

• Thing
• Photograph
• Architecture
• Artdesign
• Building
• Exhibition
• ExternalArticle
• Fineart
• Folder
• Name
• Person

Artifact Endpoint

Retrieve full object record by owner and identifier:

/api/artifact?owner={identifier.owner}&identifier={identifier.id}&mapping={MAPPING}&api.key=demo

lookup via unique_id:

/api/artifact?unique_id={artifact.uniqueId}&mapping=simple_json&api.key=demo

lookup via uuid:

/api/artifact?unique_id={artifact.uuid}&mapping=simple_json&api.key=demo

NB: ONLY mapping for legacy artifact json is available in this test

Valid mapping values:

• ESE
• ABM
• simple_json

Multimedia

Retrieve images via the Multimedia Server:

https://ems.dimu.org/image/{artifact.defaultMediaIdentifier}?dimension={WIDTH}x{HEIGHT}[-crop]

Example dimensions:

• 57x57-crop
• 145x105
• 167x167
• 174x156-crop
• 250x250
• 400x400
• 600x380
• 600x600
• 720x480
• 800x800
• 1200x1200

Images are not upsampled; size availability varies by provider.

Contact

For technical support, email support@kulturit.no.