Ingest API
Base path /api/ingest — JWT required. Runs connector ingest jobs, embeds sources for semantic search, and harvests OAI-PMH repositories. Ingest jobs run on the background queue (BullMQ).
Endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /api/ingest/status/:projectId | All IngestRun records for a project |
| POST | /api/ingest/trigger | Enqueue a connector ingest job |
| POST | /api/ingest/embed/:projectId | Embed all un-embedded sources in a project |
| POST | /api/ingest/oai | Harvest an OAI-PMH repository (synchronous, up to limit records) |
Status
GET /status/:projectId returns the IngestRun state machine for each job — useful for showing progress and surfacing failures.
Embeddings
POST /embed/:projectId generates vector embeddings (pgvector) for sources that don't have them yet, enabling per-project semantic search via the Search surface.
→ Related: Connectors · Sources