Quickstart | Gradii API Documentation

1. Get an API token

Generate a Gradii API token from your company admin panel. Tokens should only be shared with trusted backend services.

2. List interviews

curl --request GET \
  --url https://gradii.ai/api/v2/interviews/list \
  --header 'Authorization: Bearer iai_your_token_here'

3. Schedule an interview

curl --request POST \
  --url https://gradii.ai/api/v2/interviews/schedule \
  --header 'Authorization: Bearer iai_your_token_here' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "candidateName": "John Doe",
    "candidateEmail": "john@example.com",
    "interviewDate": "2026-05-12",
    "interviewTime": "10:00",
    "roundNumber": 1,
    "timezone": "Asia/Kolkata"
  }'

4. Validate Fern configuration locally

fern check
fern docs dev