Skip to content

Receiver API

The Receiver is a thin HTTP endpoint the Extractor can post captures to directly instead of writing JSON files — set prologue.output.kind to "Api" (see Configuration) and point it at a running Receiver.

EndpointPurpose
POST /capturesStores a capture with no Prologue association
POST /prologues/{prologueId}/capturesStores a capture stamped with the given Prologue id, overriding whatever id the Extractor sent

Both endpoints accept a single Capture (the shape defined in Cratis.Prologue.Contracts) and respond 202 Accepted once it’s stored.

The Receiver stores every capture in MongoDB via Cratis.Prologue.Storage, configured under the same prologue section other tools use:

PropertyTypeDefaultPurpose
prologue.mongo.connectionStringstring"mongodb://localhost:27017"MongoDB connection string
prologue.mongo.databasestring"Prologue"Database name
prologue.mongo.collectionstring"captures"Collection name

This is the same storage a service-mode Interpreter session reads from — the Receiver is how captures get into MongoDB in the first place, whether you’re feeding a Studio session or just want captures centralized instead of scattered across JSON files on disk.

JSON files (output.kind: "Json")Receiver (output.kind: "Api")
SetupNone — just a mounted folderA running Receiver + MongoDB
Consumed byBatch Interpreter, cratis prologue interpretService-mode Interpreter, Studio
Good forA single capture-and-interpret passAn ongoing or shared capture session, or a Studio-driven review