Documentation

API reference, community plugins, and integration guides for the Transfer Oracle structural auditing platform.

Quick Start

Authenticate with your API key in the X-API-Key header:

curl -X POST https://api.transferoracle.ai/v1/audit/transfer \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "features_train": [[1.0, 2.0, ...], ...],
    "labels_train": [0, 1, 2, ...],
    "features_deploy": [[1.1, 2.1, ...], ...],
    "val_accuracy": 0.85
  }'

Response includes: diagnosis (SAFE / RED_FLAG / UNDERTRAINED), per-class coverage, recommendations, and structural metrics.

Authentication

Header	X-API-Key: your_key_here
Alternative	Authorization: Bearer your_key_here
Get a key	Subscribe to receive your API key by email

API Reference

Core Audit

Method	Endpoint	Description	Credits
POST	/v1/audit/transfer	Full structural transfer audit — diagnosis, coverage, per-class breakdown, recommendations	200
POST	/v1/audit/quantization	Compare N quantization variants — returns recommended level	200×N
POST	/v1/audit/safe-level	Auto-pick the most aggressive safe quantization level	200×N

Real-Time Monitoring

Method	Endpoint	Description	Credits
POST	/v1/monitor/state	Sub-millisecond single-vector familiarity check	1
POST	/v1/monitor/buffer/append	Buffer flagged vectors for batch re-audit	1
POST	/v1/monitor/buffer/audit	Re-audit all buffered vectors	50

Metrics

Method	Endpoint	Description	Credits
POST	/v1/metrics/compare	Cosine similarity, SQNR, rank preservation (paired comparison)	50
POST	/v1/metrics/cosine	Cosine similarity statistics	10
POST	/v1/metrics/sqnr	Signal-to-quantization-noise ratio (dB)	10

Editability

Method	Endpoint	Description	Credits
POST	/v1/editability/predict	Per-class recoverability prediction after compression	50

Account

Method	Endpoint	Description
GET	/v1/account	Your tenant info, tier, and enabled endpoints
GET	/v1/account/usage	API usage statistics
GET	/v1/account/credits	Credit balance and history