> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inop.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Recommend Candidates

> Generates match insights and recommendations based on a given job description and a list of potential candidates. Returns a unique match ID and corresponding recommendation insights data for each candidate.



## OpenAPI

````yaml POST /match-insights/recommend-candidates
openapi: 3.1.0
info:
  title: INOP
  description: >-
    INOP API provides a powerful suite of endpoints designed to streamline and
    enhance the candidate screening process using AI-driven insights.
  license:
    name: MIT
    identifier: ''
  version: 1.0.0
servers:
  - url: https://public.api.inop.ai/v1/
security:
  - bearerAuth: []
paths:
  /match-insights/recommend-candidates:
    post:
      description: >-
        Generates match insights and recommendations based on a given job
        description and a list of potential candidates. Returns a unique match
        ID and corresponding recommendation insights data for each candidate.
      requestBody:
        description: Candidate to generate recommendation insights
        content:
          application/json:
            schema:
              type: object
              properties:
                jobDescription:
                  type: string
                  default: >-
                    Senior Backend Engineer with experience in Python and
                    Django.
                candidates:
                  type: array
                  default:
                    - first_name: John
                      last_name: Doe
                      linkedin_url: https://linkedin.com/in/johndoe
                      email: johndoe@example.com
                      phone_number: '+1234567890'
                      resume: https://example.com/resume/johndoe.pdf
                    - first_name: Jane
                      last_name: Smith
                      linkedin_url: https://linkedin.com/in/janesmith
                      email: janesmith@example.com
                      phone_number: '+0987654321'
                      resume: https://example.com/resume/janesmith.pdf
        required: true
      responses:
        '200':
          description: job titles response
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                    default: true
                  messages:
                    type: string
                    default: ''
                  data:
                    type: object
                    default:
                      match_id: abc-d1234
                      recommendation_insights:
                        score: 85
                        strengths:
                          - JavaScript
                          - Problem-solving
                          - Teamwork
                        areas_for_improvement:
                          - Cloud infrastructure
                        cultural_fit: High Alignment
                        long_term_potential: Strong
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````