Skip to content

Kolony API documentation

Welcome to the official Kolony user guide for API integrators.

Kolony is a configurable, cloud-based platform for capturing, organising, and sharing project data and media. At its centre are collaborative Spaces — secure repositories where teams collect photos, videos, structured records (forms), and related documentation, then review and share them with the right people.

The public surface is a headless REST API under /v0. You can integrate Spaces, Channels, Modules, media, comments, forms, workflows, messaging, and more without adopting the Kolony web or mobile UI.

  • Teams integrating Kolony via RapidAPI
  • Backend and platform engineers building on the public API host
  • Product teams that need a structured place for field media and forms, exposed through their own applications

High-level examples of how integrators typically apply the platform (via the API):

Use case What Kolony helps with
Environmental monitoring Sensor logs, hotspot media, geotagged field records in a shared Space
Smart cities / infrastructure Inspection photos, drone scans, occupancy or telemetry-style media organised per project
Field research & data collection Geotagged observations, photos/video, and structured forms in one repository
Community & local programmes Events, stories, and media across sites or centres
Disaster response Rapid ground-level photos and structured situation reports with permissions
Wildlife / conservation Location-sensitive media and logs shared under controlled access
Advocacy & campaigns Evidence and visual material curated in one Space for reporting and outreach
Education & youth programmes Activity media and documentation across schools or centres
Collaborative project Spaces Channels for membership and discussion, modules for querying Space data, workflows for review/approval

These are illustrative — the same primitives (Spaces, media, forms, channels, modules, workflows) compose differently depending on your product.

  1. Space — the data repository (published media assets, attached forms, settings, modules)
  2. Channel — connects people to Spaces they can access; conversation and module-backed queries over that data
  3. Module — capability attached to a Space (today: Tags; more modules later)
  4. Comments — discussion on a Space and/or a Channel (separate from Tags)

Details: Concepts overview.

  1. Quickstart — subscribe, sign up, first successful call
  2. Concepts overview — how core resources relate
  3. API reference — interactive OpenAPI (vendored in this repo)