REST API

The Collab Server provides a REST API for snapshots, health checks, and more.

Base URL

http://localhost:4000/api

Endpoints

Health Check

GET /health

Response:

{
  "status": "ok",
  "uptime": 3600,
  "version": "1.0.0"
}

Snapshots

Create Snapshot

POST /api/snapshots
Content-Type: application/json

{
  "artworkId": "item-001",
  "sketch": "sketch-entities-001",
  "image": "data:image/png;base64,...",
  "parameters": { ... },
  "metadata": {
    "title": "Morning Light",
    "description": "Warm color palette"
  }
}

Response:

{
  "id": "snap_abc123",
  "url": "/api/snapshots/snap_abc123",
  "qrUrl": "/api/snapshots/snap_abc123/qr",
  "created": "2024-06-15T10:30:00Z"
}

Retrieve Snapshot

GET /api/snapshots/:id

Response:

{
  "id": "snap_abc123",
  "artworkId": "item-001",
  "sketch": "sketch-entities-001",
  "image": "data:image/png;base64,...",
  "parameters": { ... },
  "metadata": {
    "title": "Morning Light"
  },
  "created": "2024-06-15T10:30:00Z"
}

Snapshot Image

GET /api/snapshots/:id/image

Returns: PNG image

Generate QR Code

GET /api/snapshots/:id/qr

Query parameters:

Returns: QR code image

Lifestream

Exhibition Snapshots

GET /api/lifestream/:exhibition

Query parameters:

Response:

{
  "exhibition": "mosaik-2027",
  "snapshots": [
    {
      "id": "snap_xyz",
      "artworkId": "item-001",
      "image": "/api/snapshots/snap_xyz/image",
      "timestamp": "2024-06-15T10:30:00Z"
    }
  ]
}

Post Snapshot (from Artwork)

POST /api/lifestream/:exhibition/snapshots
Content-Type: application/json

{
  "artworkId": "item-001",
  "image": "data:image/png;base64,..."
}

Gallery

List Artworks

GET /api/gallery/artworks

Response:

{
  "items": [
    {
      "slug": "entities",
      "name": "Entities",
      "description": "Agent-based system",
      "thumbnail": "/assets/thumbs/entities.jpg"
    }
  ]
}

Artwork Details

GET /api/gallery/artworks/:slug

Statistics

GET /api/stats

Response:

{
  "connections": {
    "total": 42,
    "artworks": 15,
    "studio": 2
  },
  "snapshots": {
    "total": 1234,
    "today": 56
  },
  "uptime": 86400
}

Error Handling

Errors are returned as JSON:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Snapshot not found",
    "statusCode": 404
  }
}

Status Codes

Rate Limiting

CORS

CORS is enabled for the following origins:

http://localhost:*
https://*.quiet-frames.de

Authentication (optional)

For protected endpoints:

Authorization: Bearer <token>

Token is generated via Art.Works! Studio.