Overview

Welcome to the Tal.AI API documentation. This API allows recruiters to review, rank, and produce summaries of applications to their jobs.

Review Application

The Review Application endpoint enables recruiters to process job candidate data and obtain rankings and summaries.

API Endpoint

The API endpoint for reviewing job applications is:

POST https://api.tal.ai/api/v1/review-application

Authentication

To authenticate your requests, include your API key in the X-API-Key header of each request.

Request Parameters

The following parameters should be included in the JSON payload of the request:

• cv_link: Link to the candidate's CV (doc, docx, or pdf)
• job_title: Job title
• job_location_town: Job location town/city
• job_location_postcode: Job location postcode
• job_description: Job description
• ranking_criteria: Specific criteria for ranking a candidate

Example Request

POST /api/v1/review-application HTTP/1.1
Host: api.tal.ai
Content-Type: application/json
X-API-Key: your_api_key

{
    "cv_link": "https://example.com/cv.pdf",
    "job_title": "Software Engineer",
    "job_location_town": "London",
    "job_location_postcode": "SW1A 1AA",
    "job_description": "We are looking for a skilled software engineer...",
    "ranking_criteria": "Experience with PHP and MySQL"
}
                    

Example Response

{
    "Executive Summary": "The candidate has relevant experience in software development and possesses skills in PHP and MySQL.",
    "Candidate Score": 4,
    "Interview Questions": [
        "Can you describe a complex project you worked on and how you contributed to its success?",
        "How do you stay up-to-date with the latest technologies and programming practices?"
    ],
    "Request Count": 1
}
                    

The API response includes an executive summary of the candidate, a candidate score, suggested interview questions based on the provided job description and ranking criteria, and the current months request count.