Interview-as-a-Service API
REST API v1 with OpenAPI 3.1 spec. Create interviews, submit answers, extract facts, generate blueprints, connect data sources, receive webhooks, and embed surveys — all via standard HTTP. Pro and Enterprise tenants. Talk to Tom for a key.
Interview Endpoints
POST /api/v1/interviews — create. GET /api/v1/interviews/:id — retrieve. POST /api/v1/interviews/:id/answers — submit answer and get next question. GET /api/v1/interviews/:id/facts — extracted facts. GET /api/v1/interviews/:id/blueprint — synthesised blueprint.
Data Connection Endpoints
POST /api/v1/connections — connect CSV, Google Sheets, Salesforce, HubSpot, or Postgres. GET /api/v1/connections/:id/schema — inspect schema. POST /api/v1/connections/:id/query — query connected data.
Webhook Callbacks
interview.completed, facts.extracted, blueprint.ready, feedback.processed. Signed payloads (HMAC-SHA256). Configurable retry policy.
API Key Management
Scoped permissions: read-only, write, admin. Per-key rate limits. Rotate keys without downtime. CORS enabled for browser clients.
Feedback API (Self-Healing)
POST /api/v1/feedback — submit user feedback from any widget. Triggers the loop: Claude analyses, classifies (bug/feature/UX), assesses severity, generates title, writes fix, tests, deploys. Webhook fires feedback.processed.
Embeddable Survey Widget
One script tag drops a full conversational interview into any website. Customise colours, questions, callbacks. Works with React, Vue, Svelte, plain HTML. Shopify + WordPress plugins available.
Create an interview
curl -X POST https://app.dataflowadvisory.com/api/v1/interviews -H 'Authorization: Bearer sk-...' -H 'Content-Type: application/json' -d '{"project": "default", "type": "user", "participant_email": "jane@example.com"}'
Submit an answer
curl -X POST https://app.dataflowadvisory.com/api/v1/interviews/:id/answers -H 'Authorization: Bearer sk-...' -d '{"question_id": "q_123", "text": "We process about 200 orders per day", "qtype": "open_text"}'
Connect a data source
curl -X POST https://app.dataflowadvisory.com/api/v1/connections -H 'Authorization: Bearer sk-...' -d '{"type": "hubspot", "credentials": {"access_token": "pat-..."}}'
Embed widget (one line)
<script src="https://app.dataflowadvisory.com/embed.js" data-project="your-project" data-theme="dark" data-callback-url="https://your-app.com/webhook"></script>
Submit feedback (self-healing)
curl -X POST https://app.dataflowadvisory.com/api/v1/feedback -H 'Authorization: Bearer sk-...' -d '{"page": "/dashboard", "type": "bug", "message": "Chart labels overlap on mobile", "screenshot_url": "..."}'
Register a webhook
curl -X POST https://app.dataflowadvisory.com/api/v1/webhooks -H 'Authorization: Bearer sk-...' -d '{"url": "https://your-app.com/hooks/dataflow", "events": ["interview.completed", "blueprint.ready", "feedback.processed"]}'
Python SDK
pip install dataflow-advisory. Async support. Type hints. Auto-retry with backoff.
Node.js SDK
npm install @dataflow/sdk. TypeScript definitions. Promise and callback interfaces.
Ruby SDK
gem install dataflow. Rails integration. Webhook verification helper.
Get your API key.
API access ships with the Phase 1 retainer for tenants who need it. Talk to Tom about scope and rate limits.
Join 50+ organisations already using DataFlow