API Documentation
Integrate our powerful recruitment AI into your existing systems with our easy-to-use APIs.
CV Parsing API
Extract structured data from candidate CVs using AI
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/cv-parsing
Request Body:
{
"file": "FILE OBJECT"
}AI CV Detector API
Identify whether a CV was generated by AI or written by a human.
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/cv-ai-detector
Request Body:
{
"file": "FILE OBJECT"
}Job Match API
Match a CV with a job and get the match percentage.
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/job-match
Request Body:
{
"file": "FILE OBJECT",
"job_data": "Job content in concatenated form with spaces",
"instructions_prompt": "Matching instructions"
}Combined Job Match & AI Detector API
Get both job match percentage and AI detection results in one call.
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/job-match/ai-detector
Request Body:
{
"file": "FILE OBJECT",
"job_data": "Job content in concatenated form with spaces",
"instructions_prompt": "Matching instructions"
}Phone Call Integration
Initiate outbound calls between recruiters and candidates, and generate a conversation transcript in text format, an audio file, and a summary with key points discussed.
Socket.IO Connection:
const socket = io("https://api.903-053-408-7463.fiona.botzbrain.com", {
query: {
"api-key": "[your-api-key]",
source: "fiona-phone-call-socket-io",
clientCallbackUrl: "Your callback URL",
_sid: "Unique identifier"
}
});
// Initiate call:
socket.emit("hr-start-phone-call", {
phoneNumber: "Candidate's phone number",
from: "Twilio-verified number",
proxy_phone_number: "Recruiter's phone number"
});Fiona AI meeting API
Create a meeting that will be led by an AI (Fiona AI)
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/ai-meeting/create
Request Body:
{
"meeting_title": "The meeting title",
"meeting_description": "The meeting description",
"date_from": "The meeting start date. Ex. 2025-09-17",
"time_from": "The meeting start time. Ex. 10:25",
"date_to": "The meeting end date. Ex. 2025-09-17",
"time_to": "The meeting end time. Ex. 10:30",
"fiona_host_questions": [
"A list of questions that Fiona uses to conduct the interview",
"Ex. What is your name?",
"Ex. What excited you to apply for this job",
"Ex. Talk a bit about your past AI projects",
"etc..."
],
"candidate_email_addresses": [
"candidate1@gmail.com",
"candidate2@hotmail.com"
],
"clientCallbackUrl": "The API that Fiona will call to send the interview analysis, summary, question responses, and all relevant information about the interview once the data is ready",
"fiona_job_id": "The ID of the job for which Fiona will conduct the interview. This job must already be created on Fiona’s side before using the ID",
"fiona_profile_id": "The profile ID of the candidate for whom Fiona will conduct the interview. This profile must already be created on Fiona’s side before using the ID"
}Fiona AI meeting embeded Iframe
Use this script directly in your app or website to embed the Fiona AI interview iframe
POST https://api.903-053-408-7463.fiona.botzbrain.com/aits/partnership/api-program/ai-meeting/create
<!-- Where to display the Fiona AI meeting -->
<div id="fiona-ai-meeting"></div>
<!-- Integration script -->
<script
src="https://api.903-053-408-7463.fiona.botzbrain.com/widgets/fiona-ai-meeting.js"
data-org="[your-organization-id]"
data-meeting-id="[meeting-id]"
data-locale="en-CA"
data-api-key="[your-api-key]"
data-lang="en"
style="width: 100%; height: 600px; border: none"
async
></script>
Powered by