Skip to content
Cadivor Open API settings
DEVELOPER API

Connect BOM analysis to your workflow.

The v1 API accepts a BOM upload, saves the resulting analysis to your workspace, and lets authorized integrations list and retrieve its reports.

Access and limits

API ACCESS

Workspace-scoped keys

Create an API key in Cadivor under Settings → Billing → Developer API keys. A workspace owner or admin must have the Professional API add-on or another plan entitlement. Copy the secret when it is created; Cadivor shows it once. Revoking API access, the key, or workspace membership disables it.

RATE LIMITS

Per-key request limits

General v1 requests are limited to 180 per minute per API key. Analysis submissions are limited to 5 per minute per key. A limit response uses HTTP 429; wait before retrying. BOM uploads are limited to 10 MB.

Send the key as Authorization: Bearer <API_KEY> or X-API-Key: <API_KEY>. Treat it as a password: store it server-side and never put it in a browser app or public repository.

Endpoints

Method and pathPurpose
POST /v1/analysesSubmit multipart/form-data with a file field containing the BOM. The response includes the saved analysis ID and report links.
GET /v1/reports?limit=25&offset=0List workspace reports. Limit is 1–100; offset is 0–100,000.
GET /v1/reports/{analysis_id}Retrieve one report that is visible to the API key’s workspace.

Submit a BOM

Replace the API base and key with your deployment values. This example reads the synchronous analysis response and prints the saved report endpoint.

curl --fail-with-body -H "Authorization: Bearer $CADIVOR_API_KEY" -F "file=@./bom.csv" "${CADIVOR_API_BASE%/}/v1/analyses"

A successful response includes analysis_id, report_url, and report_endpoint. Use GET /v1/reports/{analysis_id} to retrieve the full saved report later.

Signed event webhooks

Workspace owners and admins with API access can add an HTTPS destination from Settings → Billing → Developer API keys → Outgoing webhooks. Cadivor encrypts the URL and signing secret at rest; the secret is shown once.

EventWhen it is sent
analysis.completedA BOM submitted through POST /v1/analyses has been saved.
monitoring.alerts.createdA live scheduled check records a new source-backed alert for an opted-in workspace.
webhook.testA workspace admin sends a test from Settings.

Every delivery includes X-Cadivor-Webhook-Id, X-Cadivor-Webhook-Event, X-Cadivor-Webhook-Timestamp, and X-Cadivor-Webhook-Signature. Verify the HMAC-SHA256 signature against the exact raw body with your one-time signing secret before parsing the JSON. Failed deliveries retry with backoff up to five times; recent attempts appear in Settings. Cadivor rejects redirects and destinations that resolve to private or reserved IP addresses.

Monitoring webhooks are emitted only after a live scheduled check finds a source-backed change. A dry run makes no supplier calls and sends no webhooks.

Webhook payloads can contain workspace information such as part numbers, alert details, and evidence links. Subscribe only endpoints authorized to receive those data.

Need an API key?

Professional workspace owners and admins can create or revoke keys in Cadivor billing settings.