P
ProveIQ
Exit-Readiness Mandate 1 · API-first

API reference.

Every capability is an endpoint. Every endpoint is versioned, rate-limited, and documented. Full OpenAPI 3.0 spec: openapi.yaml.

Auth: session cookie or X-ProveIQ-KeyRate: 60/min user · 600/min key

Public

GET/api/public/agreement-rate
Global AI-human agreement rate. No auth. Returns demo payload when total=0 so marketing surfaces stay engaging pre-first-pilot.
curl https://proveiq.in/api/public/agreement-rate
GET/api/leaderboard
Public leaderboard by domain. Rate-limited 60 req/min per IP.
curl "https://proveiq.in/api/leaderboard?domain=tech&limit=10"

AI Pillars — v1

POST/api/v1/playbooks/generate
Pillar 1 — Generate DIY playbook from employer brief.
curl -X POST https://proveiq.in/api/v1/playbooks/generate \\
  -H "X-ProveIQ-Key: $KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"title":"Build a checkout funnel","deliverables":["Figma","Next.js prototype"],"durationDays":10,"domain":"design"}'
POST/api/v1/integrity/check
Pillar 3 — Submission integrity score (plagiarism + AI-content + git history)..
curl -X POST https://proveiq.in/api/v1/integrity/check -H "X-ProveIQ-Key: $KEY" -d @submission.json
POST/api/rubrics/generate
Pillar 4 — Extract structured rubric from unstructured brief.
curl -X POST https://proveiq.in/api/rubrics/generate -H "X-ProveIQ-Key: $KEY" -d @brief.json

DPDP — Data Subject Rights

GET/api/dsr/access
Full data export as JSON + PDF bundle.
curl -H "Cookie: $SESSION" https://proveiq.in/api/dsr/access -o my-data.zip
DELETE/api/dsr/erasure
Hard cascading delete. Backups purged within 30 days.
curl -X DELETE -H "Cookie: $SESSION" https://proveiq.in/api/dsr/erasure

Versioning + stability

  • • /api/v1/* — frozen surface. Breaking changes ship as /v2/ with a 12-month deprecation window on /v1/.
  • • /api/* (unversioned) — internal-stable. We do not break these but do not promise compat across majors.
  • • Contract tests — every /v1/ endpoint has a pinned contract test that fails CI on any breaking change.
  • • Changelog — every API change lands in /changelog.
Download openapi.yaml