Developers · API & SDK
REST API, TypeScript SDK, embeddable runner, webhooks, branded PDFs. Build and test for free — talk to us for live-mode pricing.
What you get
Everything below is in every plan — the differences between Starter, Growth and Enterprise are about volume, support and compliance, not features.
Strongly typed JS/TS SDK on top of a clean REST API. First call to a working session in under 10 minutes.
Drop the assessment-runner iframe (or React component) anywhere. White-labelled, theme-aware, mobile-first.
Listen for session.completed, score.ready, report.generated. Signed payloads, automatic retries, dead-letter queue.
Pull a branded PDF for any session via one API call. Use your logo, your colours, your footer.
Quickstart
In about ten minutes. The TypeScript SDK handles auth, retries, webhook verification, and locale-aware report fetching. Server-side or edge — whatever your stack runs on.
// 1. Install the SDK
// npm i @vegacap/sdk
import { VegaCap } from '@vegacap/sdk';
const client = new VegaCap({
apiKey: process.env.VEGACAP_API_KEY!,
mode: 'test' // free until you flip to 'live'
});
// 2. Create a session for a candidate
const session = await client.sessions.create({
product: 'aapa', // 'aapa' | 'tfd' | 'lpm' | 'lpmu' | 'disc' | 'fra'
candidate: { externalId: 'cand_42' },
locale: 'en-IN'
});
// 3. Launch (redirect, iframe, or in your React app)
console.log(session.launchUrl);
// 4. Listen for completion
client.webhooks.on('session.completed', async (evt) => {
const result = await client.sessions.get(evt.sessionId);
// result.scores, result.bands, result.topMatches, ...
});Endpoints you will actually use
Most integrations need four routes. Create a session, read the result, ask the coach, pull the PDF. The rest is webhooks doing the work for you.
Create an assessment session for a candidate or employee. Returns a session id and a launch URL.
Read session status, progress, and the full scored result — including bands, percentiles, top matches.
Send a message to the AI coach for a given user. Replies are grounded in their assessment scores by default.
Branded PDF for a completed session. Returns a streaming binary response — no extra round-trips.
What's in every key
Every API key gets the full feature surface — test-mode sessions, webhook signature helpers, all 12 languages, all 6 products. You only pay when a real session completes.
Build, integrate, and stress-test without paying a rupee. Only completed live sessions are billed.
Per-environment keys, per-product scopes, rotate any time. Server-side and client-publishable variants.
HMAC signatures on every webhook with a 5-minute replay window. SDK helpers verify on one line.
Pass a locale on session create. Items, prompts, and report copy all switch automatically.
Candidates own their session token. Your dashboard shows only what they consent to share.
AAPA, TFD, LPM-VT, LPM-U, DiSC, FRA. One API surface, six scoring engines underneath.
Pricing
Test-mode sessions are always free — no card, no quota. Live-mode pricing is custom-quoted based on volume, products in use, and support tier. Reach out and we will scope a plan that fits.
Start in 15 minutes