API Reference Overview

Programmatic access to BOMs, the Risk Engine, Watchlist, and Reports.

TekPulse exposes a REST API for programmatic access. Use it to upload BOMs from CI/CD, fetch risk scores into your PLM system, or push procurement-system events into our watchlist. Available on Professional and Enterprise tiers.

Base URL & authentication

https://api.tekpulse.io/v1

Authentication uses bearer tokens. Generate an API key in Settings → Integrations → API Keys. Pass it as Authorization: Bearer YOUR_KEY.

Most-used endpoints

POST /v1/boms

Upload a new BOM (multipart/form-data with file).

POST /v1/boms/{id}/assess

Trigger risk assessment for an existing BOM.

GET /v1/boms/{id}

Fetch full BOM detail including scored components.

GET /v1/components/{mpn}/risk

Get risk score for a single MPN without uploading a BOM.

POST /v1/watchlist

Pin a component to your watchlist.

GET /v1/reports/{bom_id}.pdf

Generate a PDF risk report for a BOM.

POST /v1/webhooks/subscribe

Enterprise: subscribe to risk events via webhook.

Rate limits

Free tier

No API access.

Professional

100 requests/minute, 10,000/day.

Enterprise

500 requests/minute, unlimited daily.

Quick start

curl -X POST https://api.tekpulse.io/v1/boms \
  -H "Authorization: Bearer $TEKPULSE_API_KEY" \
  -F "name=Production Board v1.2" \
  -F "[email protected]"