Quickstart

Get from zero to your first AI screen in under 15 minutes.

AI Phone Screening

VAPI places real phone calls, conducts structured 15-minute interviews, and returns a scored transcript within minutes.

Score breakdown

VAPI configuration

VAPI_API_KEY=your_vapi_api_key
VAPI_PHONE_NUMBER_ID=your_phone_number_id
VAPI_WEBHOOK_SECRET=your_webhook_secret

Webhook endpoint

POST https://unitityai.com/api/sourcing/webhook

VAPI Integration

VAPI powers all AI phone screens on Unitity AI — outbound calls, voice conversation, transcription, and scoring.

Setup

Assistant config

{
  "model": {
    "provider": "openai",
    "model": "gpt-4o",
    "systemPrompt": "You are screening {name} for {role}...",
    "successEvaluationRubric": "NumericScale"
  }
}

Authentication

Authenticate all API requests with a Bearer token and your tenant ID.

Base URL

https://unitityai.com/api

Headers

Authorization: Bearer your_api_key
x-tenant-id: your_tenant_slug

Rate limits

Candidates API

Create, read, update, and manage candidates programmatically.

Endpoints

Example

const res = await fetch('https://unitityai.com/api/candidates', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${"{"}API_KEY{"}"}`,
    'x-tenant-id': 'your-tenant',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Jordan Rivera',
    email: 'jordan@example.com',
    phone: '+13035551234',
    req_id: 'req_uuid_here'
  })
});

Account Setup

Configure your workspace, invite team members, and set up your branding before going live.

Workspace settings

Navigate to Settings → General to configure your company name, logo, and primary color. These are used in white-labeled emails and client portal pages.

Inviting team members

Go to Settings → Team → Invite. Enter an email and assign a role (Admin, Recruiter, or Viewer). Each recruiter seat counts against your plan allocation.

Candidates

Add, manage, and track candidates through every stage of your pipeline.

Adding candidates

Three ways: manually via form, by uploading a resume (PDF or Word), or via CSV bulk import. Resume parsing uses GPT-4o-mini to extract name, email, phone, title, company, location, skills, and experience.

CSV import

Candidates → Import CSV. Download the template, populate, and upload. Up to 500 candidates per import with automatic column mapping.

Requisitions

Requisitions define the roles you're hiring for. Each candidate is linked to a req and AI screens are scored against it.

Creating a requisition

Requisitions → New Req. Enter title, location, salary range, and a brief description. AI generates the full job description automatically.

Candidate Sourcing

AI searches Apollo and PeopleDataLabs to find matching candidates before you post the job.

Apollo setup

APOLLO_API_KEY=your_apollo_key

Pipeline Management

Track every candidate through your hiring funnel. Move stages inline, see AI scores, and take actions without leaving the list.

Stages

Default: Applied → AI Screened → Interview → Offer → Placed → Rejected. Stage names can be customized per tenant in Settings.

Client Portal

White-labeled hiring manager portal — clients review AI-scored candidates and request interviews without touching your recruiter dashboard.

Sending a portal invite

On any candidate profile, click "Send Portal Invite." Hiring manager receives a branded magic link — no password required.

Email Sequences

Automated multi-touch follow-up sequences keep candidates warm from the moment they enter your pipeline.

Default sequence

Day 0 (introduction), Day 3 (check-in), Day 7 (status update), Day 14 (final follow-up). Customize each template in Settings → Email Templates.

Recruiter AI

Describe what you need in plain English. Recruiter AI builds reqs, sources candidates, and kicks off screens automatically.

"I need 5 React engineers, fintech, remote, $120–150k, starting August 1"

Interview Scheduling

Zero-friction interview booking — hiring manager requests, AI emails slots, candidate confirms, invite fires automatically.

SendGrid

Unitity AI uses SendGrid for all outbound email — follow-up sequences, briefings, portal invites, and offer letters.

SENDGRID_API_KEY=SG.your_key
SENDGRID_FROM_EMAIL=recruiting@yourdomain.com

Stripe Billing

Unitity AI uses Stripe for per-seat subscription management and metered screen overage billing.

STRIPE_SECRET_KEY=sk_live_your_key
STRIPE_WEBHOOK_SECRET=whsec_your_secret

Webhooks & Zapier

Subscribe to real-time events from Unitity AI to trigger workflows in your own systems or via Zapier.

Events

candidate.created · candidate.stage_changed · screen.completed · placement.created · interview.scheduled · offer.sent

Requisitions API

Create and manage requisitions programmatically.

Webhook Events

Receive real-time event payloads when key actions occur.

{
  "event": "screen.completed",
  "tenant_id": "your-tenant",
  "data": { "score": 87, "recommendation": "Strong Hire" }
}

SDKs & Client Libraries

Official client libraries for integrating Unitity AI into your own applications.

JavaScript / TypeScript

npm install @unitityai/sdk

import { UnitityClient } from '@unitityai/sdk';

const client = new UnitityClient({
  apiKey: 'your_api_key',
  tenantId: 'your_tenant',
});

// List candidates
const candidates = await client.candidates.list({ stage: 'ai_screened' });

// Trigger AI screen
await client.candidates.screen('candidate_id');

Python

pip install unitityai

from unitityai import UnitityClient

client = UnitityClient(api_key="your_api_key", tenant_id="your_tenant")

# List candidates
candidates = client.candidates.list(stage="ai_screened")

# Trigger AI screen
client.candidates.screen("candidate_id")

What's New

Recent platform updates, new features, and improvements.