Skip to main content
pb.submissions is the generic capture entry point. Send content or an event and Penumbra routes it: a url becomes a document, a shape paired with a source becomes an extraction, and anything else stages a delta. One door, three destinations.

​
create

const result = await pb.submissions.create({
  content: "Acme signed a 12-month renewal after a procurement review.",
});

console.log(result.route, result.status); // "delta", "applied"

​
How it routes

PayloadRouteResult
url (or as_document: true)documentIngests the URL as a document.
shape + a source_file_id or collection_idextractionReturns a next_action pointing at POST /v1/extractions/shape.
anything else (default)deltaStages a governed delta; commits unless apply: false.
Pass an explicit route ("delta", "document", or "extraction") to override the inference.

​
Methods

MethodDescription
pb.submissions.create(input)Submit content or an event for capture; routed by payload shape.
Over REST this is POST /v1/submissions. The delta route commits by default; pass apply: false to stage and review first.

Capture and extract

Direct, typed writes with pb.capture and pb.extract.

Documents

Ingest source files directly.