Quick Start Guide - Gather API

Get Started in 5 Minutes

This guide will walk you through making your first API request to the Gather API.

Get your API key

Contact your Qualifi administrator to obtain your API key (prefixed with qapi_).

API credentials are created via Eucalyptus (internal admin tool). If you don’t have access, contact your Qualifi administrator.

Set up authentication

Configure your HTTP client with the x-api-key header. Simply include your API key in the header:

x-api-key: your-api-key-here

cURL
JavaScript
Python

# Set your API key
API_KEY="qapi_your-api-key-here"

const apiKey = 'qapi_your-api-key-here';

api_key = 'qapi_your-api-key-here'

Make your first request

Retrieve your questions using the GET questions endpoint:

cURL
JavaScript
Python

curl -X GET https://api.prod.qualifi.hr/qsi/gather/questions \
  -H "x-api-key: ${API_KEY}" \
  -H "Content-Type: application/json"

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/questions', {
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/questions',
    headers={
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    }
)

data = response.json()
print(data)

Create your first question

Create a question with text-to-speech audio generation:

cURL
JavaScript
Python

curl -X POST https://api.prod.qualifi.hr/qsi/gather/questions \
  -H "x-api-key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Tell me about yourself",
    "questionScript": "Tell me about yourself and your background.",
    "generateAudio": true
  }'

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/questions', {
  method: 'POST',
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Tell me about yourself',
    questionScript: 'Tell me about yourself and your background.',
    generateAudio: true
  })
});

const question = await response.json();
console.log('Question created:', question.data);

response = requests.post(
    'https://api.prod.qualifi.hr/qsi/gather/questions',
    headers={
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    },
    json={
        'title': 'Tell me about yourself',
        'questionScript': 'Tell me about yourself and your background.',
        'generateAudio': True
    }
)

question = response.json()
print('Question created:', question['data'])

Audio generation is asynchronous. The initial response includes the question, and the audioUrl will be populated when audio generation completes. You can use webhooks to be notified when audio is ready.

Create your first interview

Create an interview with your questions:

cURL
JavaScript
Python

curl -X POST https://api.prod.qualifi.hr/qsi/gather/interviews \
  -H "x-api-key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Software Engineer Interview",
    "displayName": "Software Engineer Interview",
    "interviewType": "standard",
    "questionIds": ["question-id-from-step-4"]
  }'

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/interviews', {
  method: 'POST',
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Software Engineer Interview',
    displayName: 'Software Engineer Interview',
    interviewType: 'standard',
    questionIds: ['question-id-from-step-4']
  })
});

const interview = await response.json();
console.log('Interview created:', interview.data);

response = requests.post(
    'https://api.prod.qualifi.hr/qsi/gather/interviews',
    headers={
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    },
    json={
        'title': 'Software Engineer Interview',
        'displayName': 'Software Engineer Interview',
        'interviewType': 'standard',
        'questionIds': ['question-id-from-step-4']
    }
)

interview = response.json()
print('Interview created:', interview['data'])

What’s Next?

API Reference

Explore all available endpoints and their parameters

Guides

Learn how to create interviews and send invites

Webhooks

Set up webhooks for real-time event notifications

Code Examples

Browse code examples in multiple languages

Common Issues

401 Unauthorized Error

Check that your API key is correct and included in the x-api-key header. Verify the API key is prefixed with qapi_ and hasn’t been revoked.

404 Not Found

Verify you’re using the correct base URL and endpoint path. All endpoints are prefixed with /qsi/gather/.

429 Too Many Requests

You’ve exceeded the rate limit. Check the X-RateLimit-Remaining header and wait until the reset time indicated in X-RateLimit-Reset.

Get Started

API Reference

Guides

Code Examples

Resources

Documentation Index

​Get Started in 5 Minutes

​What’s Next?

API Reference

Guides

Webhooks

Code Examples

​Common Issues

Get Started in 5 Minutes

What’s Next?

Common Issues