PUBLIC B2B API · V1
Build a secure Excel data integration
The v1 contract is implemented locally for approved B2B customers and disabled by default. No production base URL or self-service access is available.
Beta / PartialDocumentation applies to platform 0.41.0 · Updated 11 August 2026
Approval journey
- Obtain B2B approval for an existing organization.
- Agree a plan, environment, scopes, rates, and quotas.
- Receive the one-time credential through a secure channel.
- Test with non-sensitive sandbox data.
- Retain request IDs and monitor limits.
Authentication
Authorization: Bearer key_<id>.<secret>
Keys are environment-specific, scoped, expiring, optionally CIDR-restricted, and rejected when the account or subscription is inactive.
IMPLEMENTED OPERATIONS
Public API surface
| Method | Path | Scope | Behavior |
|---|
| POST | /api/public/v1/excel/inspect | excel.inspect | Inspect one bounded CSV, TSV, or XLSX source |
| POST | /api/public/v1/excel/profile | excel.profile | Profile an inspected tenant-owned source |
| POST | /api/public/v1/excel/data-quality | dataquality.read | Evaluate deterministic data quality |
| GET | /api/public/v1/jobs/{job_id} | jobs.read | Read an existing tenant-owned job |
| GET | /api/public/v1/jobs/{job_id}/output | outputs.read | Download an existing published artifact |
There is no Public API endpoint to submit processing jobs, manage accounts or keys, call AI tools, or access internal/admin services.
Limits
Authenticated responses return rate and call-quota headers. Plans can enforce calls, files, rows, bytes, and per-file size. Use bounded backoff for 429 responses.
Stable errors
{"error":{"code":"…","message":"…","request_id":"REQ-…"}}
Keep the request ID for support. Never send a credential secret or workbook content in a ticket.
Versioned documentation set
The repository documentation covers getting started, authentication, API keys, scopes, rate limits, quotas, errors, Excel endpoints, existing jobs/outputs, security, examples, versioning, and the changelog under docs/public-api/.
Open Help Center