skavio-processing-api

# Skavio Processing API

## Discover Skavio MCP tools

**Skavio remote MCP server** — invoice OCR and extraction, PDF text extraction, document automation, image and media processing, transcription and meeting workflows for AI agents. Discover it in the [official MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers?search=skavio), or connect a compatible MCP client to `https://www.skavio.eu/processing/mcp` using your company-issued Bearer MCP credential.

- [MCP setup and all available tools](https://www.skavio.eu/processing/docs/mcp/)
- [MCP pricing and prepaid USDC credits](https://www.skavio.eu/processing/docs/mcp/pricing.html)
- [Official MCP server manifest](server.json)
- [x402 paid USDC verification micro-APIs](https://www.skavio.eu/x402/) · [machine-readable x402 discovery](https://www.skavio.eu/x402/.well-known/x402)

The Processing MCP uses company-scoped prepaid credits; the separate x402 micro-APIs advertise payment-required responses. Neither requires exposing private keys to Skavio.


One company-scoped API for document extraction, PDF and image tools, media processing, transcription and meetings.

- [Product and pricing](https://www.skavio.eu/api/)
- [Live developer documentation](https://www.skavio.eu/api/docs/)
- [Company workspace: register and create an API key](https://www.skavio.eu/dashboard/)
- [OpenAPI v1](openapi-v1.json) · [Developer guide](developer-guide.md)
- [Python quickstart](quickstart.py) · [Node.js quickstart](quickstart.mjs) · [Bulk guide](bulk-guide.md)
- [Postman public documentation](https://documenter.getpostman.com/view/58677341/2sBYHNWi4n) · [Collection](Skavio-Processing-API.postman_collection.json)
- [DEV.to integration article](https://dev.to/skavioeu/building-a-retry-safe-file-processing-api-estimates-idempotency-and-signed-webhooks-32p6)
- [Webhook verification](verify_webhook.py)

**API route version:** /v1. **Contract snapshot:** 1.9.0 + Pricing V2, captured 2026-10-04.

## What is new in API 1.7.0

- Monthly charged/reserved usage and separate payment history, bounded CSV and key attribution.
- Atomic company/key budgets for API, batch, bulk and paid web admission.
- Expiring API keys with granular permissions and administrator-only policy writes.
- Queue visibility, persisted alerts, cancellation of unstarted standalone jobs and governance audit.
- Idempotent replay of failed job/batch/bulk webhook deliveries using the frozen original event.
- Structured errors and X-Request-Id correlation; Czech/German/English dashboard additions.

Read the [Usage, budgets and recovery guide](governance-guide.md) for authorization, UTC month rules, limits and compatibility.

## Storage Fabric introduced in API 1.6.0

- Private S3 sources/results and compatible legacy local files.
- Verified direct uploads and resumable imports from approved customer cloud URLs.
- Company-scoped retention, archive, deletion hold and opt-in separate-bucket backups.
- Manual verified backup/restore, signed result downloads and encrypted import credentials.
- Existing Pricing V2, jobs, batches and bulk contracts remain supported.

Read the [Storage Fabric guide](storage-guide.md) for endpoints, production limits and browser upload handling.

## Bulk features introduced in API 1.5.0

- **Bulk manifests up to 100,000 items** with immutable manifest pages of 1–100 items and bounded incremental child admission.
- **Storage-aware admission** through `GET /v1/storage`, declared input/output/scratch envelopes and durable storage reservations.
- **Resume and failed-item retry** for large workloads without resubmitting successful items.
- **Crash/restart recovery** for scheduler state, reservations, checkpoints and provider-intent reconciliation.
- **Fair scheduling across companies** while preserving the current ceiling of 4 active platform jobs globally.
- Existing **100-item batches** remain available for simpler workloads.

Start with [Bulk processing guide](bulk-guide.md) or the [Python bulk quickstart](bulk_quickstart.py).
This repository contains the public developer kit. The hosted processing service requires a Skavio account and credits.

## First result

1. Register, create a company profile and generate a read/write key in the company workspace. Copy it once and keep it server-side.
2. Upload a source using multipart field `files`.
3. Call `POST /v1/estimate` without starting processing.
4. Set `max_credits` to the returned `estimated_credits`.
5. Submit `POST /v1/jobs` with a stable `Idempotency-Key`.
6. Poll the returned job ID until completed or failed; download through the authenticated result paths.

The included invoice is **synthetic**, contains no customer data, and can be used for an extraction test.

### Python 3.10+

```bash
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
# Set SKAVIO_API_KEY securely in your local environment.
export SKAVIO_IDEMPOTENCY_KEY="your-persisted-invoice-request-001"
python quickstart.py
```

### Node.js 22+

```bash
# Set SKAVIO_API_KEY securely in your local environment.
export SKAVIO_IDEMPOTENCY_KEY="your-persisted-invoice-request-002"
node quickstart.mjs
```

Both examples use `sample-invoice.txt`; set `SKAVIO_SOURCE` to a PDF/image/text source to change it. They estimate cost before submission and write JSON output into `results/`.
For intentional processing of a different source or changed payload, use a **new** idempotency key.
These examples are server-side starters. For the official Python and JavaScript SDK clients, see [sdk/README.md](sdk/README.md); durable workflow pipelines are documented in [workflow-guide.md](workflow-guide.md).

### Postman

Import the collection or fork its public workspace copy. Set **your own local/private environment** variable `api_key`; never save a real key in the public collection. Set `source_file` to a local source. Run Upload → Estimate → Submit → Job status → Download. Poll every 3–10 seconds until the job is terminal before downloading.
Requests cover the API-key processing endpoints; administration, key creation, billing and webhook registration use an interactive company administrator session in the dashboard.
Before a new business request, clear `upload_id`, `job_id`, `download_path`, `max_credits` and `idempotency_key` in your private environment. Preserve the idempotency key when retrying the same submission.

## What can I process?

| Workflow | Operations |
| --- | --- |
| Documents | `flow-extract` → XLSX, CSV, JSON; chosen fields, evidence, review flags |
| PDFs | merge, split, extract/delete/rotate pages, compression, watermark, page numbering, protect/unlock with your password, OCR |
| Images | resize/crop/rotate/flip, compression, format conversion, OCR |
| Audio/video | conversion, trimming, compression; video rotation/resolution/mute |
| Speech | `transcribe`, `meeting` |

[Capabilities snapshot](capabilities.json) lists exact operation names. Query `GET /v1/capabilities` for current prices and limits.
Normal file jobs accept one source; PDF merge accepts 2–20 PDFs; Flow can process multiple document sources. Transcribe and Meeting accept one media source. Batch processing supports up to 100 items. API 1.5.0 bulk manifests support up to 100,000 items with incremental dispatch; see [bulk-guide.md](bulk-guide.md). Standalone jobs do not support arbitrary operation chaining. Durable linear process/review/archive pipelines are available; see [workflow guide](workflow-guide.md).

## Credits and price control

All web tools and API share a prepaid company wallet. No unlimited processing entitlement is advertised in this kit.
The server measures bytes, pages and media duration. It reserves the quoted amount on submission, charges that fixed quote on success, and releases the reservation on failure.
Use `max_credits` to reject unexpectedly expensive submissions and `GET /v1/wallet` to track balance and reservations.

| Operation | Pricing V2 |
| --- | --- |
| Raw OCR text (ocr-txt) | 3 credits/page |
| OCR document output (ocr-docx / ocr-pdf) | 10 credits/page |
| Flow extraction and export | 25 credits/page |
| PDF/image/office/text file operation | 2 per started 25 MB or 10 pages, larger basis per source |
| Transcribe | 8 per started minute |
| Meeting | 15 per started minute |
| File Toolbox audio/video | 4 per started minute |

Nominally 1 EUR = 1,000 credits. Top-ups: EUR10/10,000; EUR25/26,000; EUR50/53,000; EUR100/108,000; EUR250/280,000; EUR500/570,000. A retail EUR6.99/6,990 pack is also available.

Monthly plans: Starter EUR29/30,000 credits; Business EUR79/85,000; Pro EUR199/225,000; Enterprise EUR499/600,000. Paid credits never expire; monthly credits roll over. Current plans share the deployment processing limits.

Web tools and API share one wallet. Submit reserves the measured quote; success charges it once; a permanent failure releases it. Temporary provider outages keep jobs queued with durable checkpoints and reserved credits. Existing quoted jobs and purchased checkout/subscription offers retain their original amounts.

Canonical live catalog: GET /v1/pricing. Always estimate before submission and use max_credits rather than hard-coding a rate.

## Reliability and integration rules

- `queued → processing → completed | failed`; submission returns HTTP 202.
- Replaying the identical job request with the same idempotency key returns the same job. Changing its payload returns 409.
- Persist business request, exact payload, key and job ID in your system. If a response is lost, retry with the original key.
- A failed job releases credits; an intentional new attempt uses a new key.
- Provider outages and service restarts preserve durable jobs/checkpoints and reservations; permanent failures release them.
- Webhooks deliver at least once; verify HMAC on the raw bytes and deduplicate event IDs. Polling remains supported.
- Results/source retention defaults to 7 days. Storage Fabric policy, archive and hold control object retention; inspect retain_until