Dashboard
5-Minute Guide

Quick-Start Guide

From zero to your first ranked application list in under 5 minutes.

1

Get your API Key

Navigate to your Krinai Dashboard → Settings → Integrations → API Keys. Click Create API Key, give it a name, choose a scope (read or write), and copy the key — it's shown only once.

Store your key in an environment variable — never commit it to source control.

Your key looks like:

krnai_live_AbCdEfGhIjKlMnOpQrStUvWxYz1234567890Ab
2

Install the SDK

Install the official Krinai SDK for your language, or use the REST API directly via cURL/Fetch.

npm install krinai-sdk
3

Initialize the Client

import { KrinaiClient } from 'krinai-sdk';

const krinai = new KrinaiClient({
  apiKey: process.env.KRINAI_API_KEY,  // krnai_live_...
  baseUrl: 'https://krinaiapi.ziontech.tech',
});
4

Your First API Call

Fetch your job listings and the AI-ranked candidate applications in a single call.

// List your jobs
const jobs = await krinai.jobs.list();
console.log(jobs);  // [{ id, title, status, application_count }]

// Get ranked applications for a job
const apps = await krinai.applications.list(jobs[0].id);
console.log(apps[0].ai_score);  // e.g. 92
5

Real-Time Webhooks

Instead of polling, register a webhook to receive real-time events. Krinai signs every payload with HMAC-SHA256 using your webhook secret.

import express from 'express';
import crypto from 'crypto';

const app = express();
app.use(express.raw({ type: 'application/json' }));

app.post('/webhooks/krinai', (req, res) => {
  // Verify HMAC signature
  const sig = req.headers['x-krinai-signature'];
  const expected = crypto
    .createHmac('sha256', process.env.KRINAI_WEBHOOK_SECRET)
    .update(req.body)
    .digest('hex');

  if (sig !== `sha256=${expected}`) {
    return res.status(401).send('Invalid signature');
  }

  const event = JSON.parse(req.body);
  if (event.event_type === 'application.scored') {
    console.log('New score:', event.data.ai_score);
  }

  res.sendStatus(200);
});

FAQ

How long does AI scoring take?

Scoring typically completes in under 30 seconds per application. Complex CVs with multiple pages may take up to 60 seconds.

Can I adjust the AI scoring weights?

Yes. In the dashboard, navigate to your job → Scoring Weights. You can adjust technical skills, experience, culture fit, and communication weights using sliders. Changes apply to re-scoring instantly.

What file formats are supported for CV upload?

PDF (recommended), DOCX, DOC. Maximum file size: 10 MB.

Is the data GDPR-compliant?

Yes. Krinai is built GDPR-first. You can erase candidate PII via the API (DELETE /applications/{id}/erase-pii), set retention policies, and export all candidate data at any time.

What are the rate limits?

Starter: 100 req/min. Pro: 1,000 req/min. Unlimited: 10,000 req/min. Enterprise: custom.

Need the full endpoint schema?

View API Reference →