Presets
Available in: Pro, Enterprise. Saved extraction settings on a preset are Enterprise only.
Presets keep requests short and results consistent by naming a prepared extraction setup that you reference by ID.
Instead of repeating a schema and settings on every request, you send the preset ID. Two kinds exist: curated presets that ship with Xberg, and saved presets that you create in a project. Presets need no setup beyond a project API key, and structured extraction needs a configured model.
Curated presets
Section titled “Curated presets”Curated presets are a read-only registry fixed at build time. The list is public and unpaginated:
curl "$XBERG_URL/v1/presets"curl "$XBERG_URL/v1/presets/$PRESET_ID"Each entry has an ID, a name and a description. Apply one to an extraction with options.preset:
curl -X POST "$XBERG_URL/v1/extract" \ -H "Authorization: Bearer $XBERG_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "documents": [{ "filename": "invoice.pdf", "data": "<base64>" }], "options": { "preset": "REPLACE_WITH_PRESET_ID" } }'Take the preset ID from the list. options.preset and options.saved_preset_id are mutually exclusive.
A curated preset can run structured extraction, which needs a configured model. See Structured extraction and the model settings in Pro configuration.
Saved presets
Section titled “Saved presets”A saved preset is a project-scoped, user-authored structured-extraction definition. Create one with a name and a JSON schema:
curl -X POST "$XBERG_URL/v1/saved_presets" \ -H "Authorization: Bearer $XBERG_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "invoices", "description": "Invoice header fields", "preferred_call_mode": "text_only", "schema": { "type": "object", "properties": { "invoice_number": { "type": "string" }, "total": { "type": "number" } } } }'name, schema and preferred_call_mode are required. The name must be unique in the project, 1 to 255 characters. Optional fields are description, system_prompt and context_template. The routes are GET /v1/saved_presets (summaries, paginated), and GET, PATCH and DELETE on /v1/saved_presets/{preset_id}. Reference a saved preset from an extraction with options.saved_preset_id.
On Pro, a saved preset contributes its schema, system_prompt and context_template to an extraction. Two fields are stored and returned but do not change extraction. preferred_call_mode (text_only, vision_only or text_plus_vision) is validated on write and not applied, and emit_citations (default true) is not applied either. Results from a saved preset carry no citations. Do not rely on either field to change results.
Saved extraction settings (Enterprise)
Section titled “Saved extraction settings (Enterprise)”On Enterprise, a saved preset can also carry extraction_config, which is applied beneath request and per-file options. Pro rejects this field. Supply LLM credentials, provider URLs and PDF passwords with each extraction request; a preset never stores them.
SDK access
Section titled “SDK access”The SDKs wrap these routes as create_saved_preset, get_saved_preset, update_saved_preset and delete_saved_preset (camel case in TypeScript, Pascal case in Go), and presets for the curated list. See docs.sdks.xberg.io.