API reference
Available in: Pro, Enterprise
Xberg publishes one OpenAPI document for Pro and two for Enterprise. Pick the document that matches your tier in the reference below.
| Spec | Tier | Covers |
|---|---|---|
| Xberg Pro | Pro | The whole Pro API in a single document: extraction, jobs, presets, RAG, auto-tune, crawling, enrichment, uploads, plus sign-in, projects, API keys, integrations and /v1/license |
| Enterprise data plane | Enterprise | The extraction surface: /v1/extract, /v1/jobs/*, /v1/enrich, upload presigning and confirmation, /v1/auto-tune/*, /v1/crawl-jobs/*, /v1/rag/* and the preset routes |
| Enterprise control plane | Enterprise | Projects, members, API keys, webhooks, integrations and the other management routes, which Enterprise serves from a separate service |
The extraction surface is shared. Every data-plane route also exists on Pro, so client code written against the data plane runs against Pro. Pro serves project, API-key, sign-in and integration routes from the same process, so they appear in the Pro document and not in the Enterprise data-plane document.
The documents are the ones the Xberg SDKs are generated from, pinned to SDK release v0.12.0. Routes added in later product releases appear after the next SDK release. The SDK site also hosts the same reference at docs.sdks.xberg.io/openapi/.
Download the specifications
Section titled “Download the specifications”Fetch a document to generate a client in another language or to import it into an API tool:
curl -fsSLO https://cdn.jsdelivr.net/gh/xberg-io/sdks@v0.12.0/spec/pro/openapi.yamlReplace pro with api for the Enterprise data plane or backend for the Enterprise control plane. See Authentication for how requests are authorized.