Skip to Content
Getting StartedOverview

Overview

The Celper AI API gives you programmatic access to the AI interview platform. Use it to import candidates into job positions, fetch post-interview analysis results, trigger interview invitations, and receive real-time webhook notifications when key events occur.

The API is RESTful, returns JSON responses, and uses API key authentication via the X-API-Key header.

Base URL

All API requests are made to the following base URL:

https://api.celper.ai/v1

Prerequisites

Before you begin, make sure you have:

  1. Celper AI platform access — sign up at platform.celper.ai  if you don’t have one.
  2. An API key — generate one from the API Management section in the platform dashboard.

Quickstart

Get your first API response in three steps.

Get your API key

  1. Log in to platform.celper.ai .
  2. Navigate to API Management.
  3. Click Generate API Key.
  4. Give your key a descriptive name (e.g., “Backend Integration”), select the scopes you need, and click Create.
  5. Copy the key immediately — it won’t be shown again.

Test connectivity

Verify your setup by hitting the health endpoint:

curl https://api.celper.ai/v1/health

The health endpoint does not require authentication. You should receive:

200
{
  "status": "ok",
  "version": "v1",
  "timestamp": "2026-04-11T12:00:00.000Z"
}

List your job positions

Now make an authenticated request to list your job positions:

curl https://api.celper.ai/v1/job-positions -H "X-API-Key: celp_your_api_key_here"
200
{
  "success": true,
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "data": [
    {
      "id": "pos_abc123",
      "position": "Senior Developer",
      "department": "Engineering",
      "candidateCount": 42
    }
  ],
  "pagination": {
    "cursor": "eyJ...",
    "hasMore": true
  }
}

What’s next

Now that you’ve made your first API call, explore these topics:

  • Authentication — Learn about scopes, IP allowlists, and security best practices.
  • Candidates — Import candidates, send invitations, and fetch analysis results — the core workflow.
  • Webhooks — Subscribe to real-time event notifications for interview completions and status changes.
Authentication