Developer docs

Product concepts and API reference for Copepod.

This docs site is organized around the actual platform surface: what the product does, the concepts behind it, and the REST endpoints exposed by the services in this repository.

Overview

What Copepod is built to do

Concepts

Terms used throughout the product

Tenant

Every request is scoped to a tenant. The backend uses tenant IDs, row-level isolation, and request middleware to keep data separated.

Memory

A memory is the primary tenant-owned record. It includes content, tags, sensitivity, versioning, contradiction state, and enrichment metadata.

Knowledge structure

A schema that defines the fields for a knowledge object and the enrichment rules for each field.

API key

API keys are scoped by permissions and can be rotated or revoked. Sensitive operations use step-up authentication.

API reference structure

The API reference is split into service-specific pages so you can focus on the surface area that matters to your integration.

Quick start

curl -H "X-Tenant-ID: <tenant-id>" \
  -H "Authorization: Bearer <token>" \
  "http://localhost:8082/memories/search?q=context&k=10"

Use the Memory API for application integrations and the Portal facade when you are extending the browser UI itself.