Skip to main content

Developers · API & SDK

Embed assessments,in an afternoon.

REST API, TypeScript SDK, embeddable runner, webhooks, branded PDFs. Build and test for free — talk to us for live-mode pricing.

What you get

A clean platform,not a checklist of features.

Everything below is in every plan — the differences between Starter, Growth and Enterprise are about volume, support and compliance, not features.

REST API + TypeScript SDK

Strongly typed JS/TS SDK on top of a clean REST API. First call to a working session in under 10 minutes.

Embeddable runner

Drop the assessment-runner iframe (or React component) anywhere. White-labelled, theme-aware, mobile-first.

Webhooks for everything

Listen for session.completed, score.ready, report.generated. Signed payloads, automatic retries, dead-letter queue.

PDF reports as a service

Pull a branded PDF for any session via one API call. Use your logo, your colours, your footer.

Quickstart

From npm installto scored session.

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.

quickstart.ts
// 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

A small surface,covers everything.

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.

POST /v1/sessions

Create an assessment session for a candidate or employee. Returns a session id and a launch URL.

GET /v1/sessions/{id}

Read session status, progress, and the full scored result — including bands, percentiles, top matches.

POST /v1/coach/messages

Send a message to the AI coach for a given user. Replies are grounded in their assessment scores by default.

GET /v1/sessions/{id}/report.pdf

Branded PDF for a completed session. Returns a streaming binary response — no extra round-trips.

What's in every key

Built test-mode-first,priced live-mode-only.

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.

Test-mode is always free

Build, integrate, and stress-test without paying a rupee. Only completed live sessions are billed.

Scoped API keys

Per-environment keys, per-product scopes, rotate any time. Server-side and client-publishable variants.

Webhook signature verification

HMAC signatures on every webhook with a 5-minute replay window. SDK helpers verify on one line.

12 Indian languages out of the box

Pass a locale on session create. Items, prompts, and report copy all switch automatically.

PII-safe by default

Candidates own their session token. Your dashboard shows only what they consent to share.

All 6 assessment types

AAPA, TFD, LPM-VT, LPM-U, DiSC, FRA. One API surface, six scoring engines underneath.

Pricing

Build for free.Pay only on live sessions.

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

Get an API key,start with test-mode.