API

Placeholder

This section is a placeholder. Once the OpenAPI specification for the VLIZ Collection API is published, we'll wire it in via vitepress-openapi (the same approach used in the Open Vlacc docs site).

The VLIZ DAMS exposes three HTTP services in front of MongoDB and S3:

Service	Description
Collection API (api.vliz-dams.cloud.inuits.dev)	Main backend; metadata, vocab integration, GraphQL + REST. Source: collection-api.
Storage API	File uploads/downloads; bridges to S3 (OVH) and IIIF (Cantaloupe).
IIIF (Cantaloupe)	Dynamic image server — tiles, derivatives, zoom.

All services authenticate via Keycloak (auth.inuits.io, realm vliz).

High-level architecture

(Source: clients/vliz-dams/application-overview.md.)

To-do

• Publish the Collection API OpenAPI spec at /api/openapi.json (or equivalent) and reference it here.
• Add a worked example for the most common GraphQL queries (list media, fetch by ID, follow relations).
• Document the upload flow against the Storage API.