SWOT Analysis API Documentation
Copyright Notice
© SupportFinity. All rights reserved.
This document and all content within it are the exclusive property of SupportFinity. No part of this documentation may be copied, distributed, or reproduced without written permission.
Description
The SWOT Analysis API evaluates a candidate for a specific job within a specific company by analyzing three inputs: the company brief, the job description, and the candidate’s CV. It returns a structured SWOT report containing an executive summary, total score, strengths, weaknesses, opportunities, threats, and a legal disclaimer. This API supports intelligent hiring decisions by offering quick, AI-generated insights.
1. Endpoint Information
Endpoint:
POST /ai/swot-analysis
Description:
Generates an AI-powered SWOT analysis of a candidate using company context, job expectations, and the candidate's profile.
Version: 1.0
2. Authentication
Required: Yes
Type: Bearer Token
Header:
Authorization: Bearer <token>
3. Request
HTTP Method
POST
Headers
Header | Type | Required | Description |
Authorization | string | Yes | Bearer token |
Content-Type | string | Yes | application/json |
Request Body
Schema
Field | Type | Required | Description |
companyBrief | string | Yes | Company profile or background summary |
jobDescription | string | Yes | Role description or responsibilities overview |
candidateCV | string | Yes | Candidate CV/resume content |
Example Request
{
"companyBrief": "A global healthcare technology provider focused on AI-driven diagnostics.",
"jobDescription": "Hiring a Senior Data Scientist with expertise in NLP and predictive modeling.",
"candidateCV": "Experienced data scientist with 8 years in machine learning, Python, NLP, and healthcare analytics."
}4. Response
Success Response
Status: 200 OK
Content-Type: application/json
Schema
Field | Type | Description |
summary | string | Short overview of the candidate's fit |
totalScore | number | Overall match score (0–100) |
strengths | array | Key advantages and competencies |
weaknesses | array | Limitations or capability gaps |
opportunities | array | Growth or development opportunities |
threats | array | Possible hiring risks |
disclaimer | string | Legal disclaimer for AI-generated analysis |
Example Response
{
"summary": "The candidate shows strong alignment with core NLP and predictive modeling requirements, with proven healthcare analytics experience.",
"totalScore": 87,
"strengths": [
"Strong NLP background",
"Excellent healthcare analytics experience",
"Proficient in Python and modeling"
],
"weaknesses": [
"Limited leadership experience",
"Less exposure to deep learning frameworks"
],
"opportunities": [
"Can grow into leadership roles",
"Strong potential for scaling NLP initiatives"
],
"threats": [
"May need additional onboarding for enterprise systems"
],
"disclaimer": "This AI-generated SWOT analysis is for informational use only. It should not be solely relied upon for hiring decisions. Final decisions must be made by authorized company representatives."
}5. Error Responses
400 Bad Request
{
"status": 400,
"error": "Bad Request",
"message": "Invalid or incomplete input data."
}401 Unauthorized
{
"status": 401,
"error": "Unauthorized",
"message": "Authentication required."
}500 Internal Server Error
{
"status": 500,
"error": "Server Error",
"message": "An error occurred while generating the SWOT analysis."
}6. Usage Example
cURL
curl -X POST https://api.supportfinity.com/ai/swot-analysis \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "companyBrief": "...", "jobDescription": "...", "candidateCV": "..." }'
7. Notes
Credits consumption is not included in this document.
This does not store company, job, or candidate data.
Results should support hiring decisions, not replace human judgment.
Output is optimized for quick evaluation and structured decision-making.