TypeScript API reference

Package @xberg-io/sdk. Every method below is on the client.

Extraction

Submit documents and wait for results.

Method	Description
`extract`	Submit a single document for extraction. Returns the initial {@link Job}
`extractBatch`	Submit multiple documents in a single multipart request. Returns one
`extractAndWait`

Poll, read, page through and cancel extraction jobs.

Method	Description
`listJobs`
`getJob`
`getJobResult`	Fetch a job’s stored result document (`GET /v1/jobs/{id}/result`).
`getJobPage`	Download one rendered page of an extraction job
`cancelJob`	Cancel a job (`DELETE /v1/jobs/{id}`). Idempotent: both a successful
`waitForJob`	Poll {@link getJob} until the job reaches a terminal status. Throws
`waitForJobs`
`audit`

Enterprise-only crawl job event stream.

Method	Description
`streamCrawlEvents`	Stream a crawl job’s events (`GET /v1/crawl-jobs/{crawl_job_id}/events`,

The curated preset registry, served by both tiers.

Method	Description
`presets`
`getPreset`
`getPresetSample`	Download a preset’s bundled sample file

Project-scoped presets you create and update.

Collections, documents and retrieval.

Method	Description
`listRagCollections`
`createRagCollection`
`getRagCollection`
`deleteRagCollection`
`addRagDocuments`
`deleteRagDocuments`	Delete documents from a RAG collection, by ID list or metadata filter
`reindexRagDocument`
`ragRetrieve`
`migrateRagEmbeddings`
`getRagMigrationJob`
`getRagJob`
`getRagConfig`
`setRagConfig`

Tuning jobs and their results.

Method	Description
`submitAutoTune`	Submit an auto-tune job (`POST /v1/auto-tune`). Sent as `multipart/form-data`:
`listAutoTuneJobs`
`getAutoTuneStatus`
`getAutoTuneResult`
`getAutoTuneCapabilities`
`promoteAutoTuneProfile`
`deleteAutoTuneJob`

Profiles promoted from auto-tune runs.

Enterprise-only document history.

Method	Description
`getDocument`	Enterprise only: fetch a document’s latest version with its extraction
`versions`
`diff`	Enterprise only: diff document versions (`GET /v1/documents/{id}/diff`).
`getDiffJob`	Enterprise only: poll a diff job (`GET /v1/documents/{id}/diff/{diffJobId}`).

Enterprise-only text enrichment.

Method	Description
`submitEnrich`
`getEnrichStatus`

Enterprise-only upload staging and metering.

Method	Description
`presignUpload`	Request presigned upload URLs (`POST /v1/uploads/presign`).
`confirmUpload`
`usage`
`listExtractionEvents`

Pro-only projects, keys and integrations.

Method	Description
`listProjects`
`createProject`
`listApiKeys`
`createApiKey`
`revokeApiKey`
`listIntegrations`
`createIntegration`
`getIntegration`
`deleteIntegration`
`connectIntegration`	Pro only: begin the OAuth flow for an integration
`disconnectIntegration`
`listIntegrationDocuments`
`fetchIntegrationDocument`	Pro only: download one document from an integration

All backend operations use the configured control-plane origin and credential.

Method	Description
`deleteAccount`
`getAuthConfig`
`getUserProfile`
`updateUserProfile`
`backendLogin`
`healthz`
`readyz`
`acceptInvitation`
`oauthCallback`
`backendListProjects`
`backendCreateProject`
`getProject`
`deleteProject`
`updateProject`
`getAnalytics`
`backendListApiKeys`
`backendCreateApiKey`
`backendRevokeApiKey`
`regenerateApiKey`
`listProjectAudit`
`getBilling`
`createCheckout`
`createPortal`
`backendListIntegrations`
`backendCreateIntegration`
`backendGetIntegration`
`backendDeleteIntegration`
`oauthConnect`
`backendDisconnectIntegration`
`backendListIntegrationDocuments`
`backendFetchIntegrationDocument`
`backendGetIntegrationSync`
`backendSetIntegrationSync`
`listInvitations`
`inviteUser`
`revokeInvitation`
`leaveProject`
`listMembers`
`removeMember`
`updateMemberRole`
`assignProjectRole`
`backendGetRagConfig`
`backendSetRagConfig`
`listProjectRoles`
`createProjectRole`
`getProjectRole`
`updateProjectRole`
`deleteProjectRole`
`listSamlDomains`
`createSamlDomain`
`verifySamlDomain`
`listSamlProviders`
`createSamlProvider`
`updateSamlProvider`
`deleteSamlProvider`
`sandboxExtract`
`listScimConnections`
`createScimConnection`
`listScimAdminGroups`
`replaceScimGroupRoles`
`rotateScimConnectionSecret`
`getUsage`
`listWebhooks`
`createWebhook`
`deleteWebhook`
`updateWebhook`
`listWebhookDeliveries`
`retryWebhookDelivery`
`testWebhook`
`publicSandboxExtract`

Pro liveness and coarse license/capability state.

Method	Description
`proHealthz`	Pro liveness and coarse license/capability state (`GET /healthz`).

Pro-only session and configuration reads.

Method	Description
`authConfig`
`login`

Method	Description
`getIntegrationSync`
`getLicenseInfo`	Pro only: read the running instance’s license detail (`GET /v1/license`) —
`getSubscriptionDelivery`	Enterprise only: fetch one delivery attempt with its bounded request and
`getWebhookDelivery`
`listManagedEmbeddingPresets`	List the managed embedding presets this server build ships
`listSubscriptionDeliveries`	Enterprise only: list a webhook subscription’s delivery attempts
`putLocalUpload`	Pro only: upload a document’s bytes against a presigned local capability
`setIntegrationSync`
`stopAutoTuneJob`	Stop a running auto-tune job (`POST /v1/auto-tune/{id}/stop`).