API Reference
The exact API contract is generated from the running FastAPI application. The
reference pages below document the main endpoint groups; use /openapi.json
from the same deployment for the complete schemas and operation list.
Base URL
For a local deployment, the API is served at:
http://localhost:8000Most application routes use the /api/v1 prefix. Health checks, public config,
and provider webhooks are root-level routes and do not use that prefix. SaaS
billing routes are included when the application is running in SaaS mode and
are omitted in self-hosted mode.
Authentication
Use a user JWT for dashboard and organization operations:
Authorization: Bearer <jwt-token>For organization API-key access, use either form:
X-API-Key: <api-key>or:
Authorization: Bearer <api-key>Some delegated end-user flows also accept X-End-User-Id. Authentication and
authorization are endpoint-specific, so the OpenAPI operation and the linked
reference page are authoritative for each route.
Reference groups
- Authentication
- Organizations and billing
- Projects and agents, agents and channels
- Documents and ingest, collections
- Ingestion runs: history, per-document outcomes, retry and cancel
- Connectors and MCP servers
- Chat and conversations
- Search and research
- Analytics
- Billing
Runtime source of truth
Generate the schema from pragence_server.app.main:app in the same deployment
mode and version as your integration. Route counts and enabled billing/provider
surfaces depend on that configuration. Use /openapi.json for client generation
and exact request/response models rather than older static counts.
Knowledge's reviewed server-side query is
POST /api/v1/projects/{project_id}/developer-query; follow the
Knowledge guide for authentication and publication.
Admissions APIs use /api/v1/products/admissions. The organization-resolved
/api/v1/bot and /api/v1/bot/config routes still provide entry-agent information;
their names do not imply the old Bot entity. Use the current schema and route
semantics rather than historical compatibility descriptions or source layouts.