matching

Match multiple candidates against a single offer (max 5000)

Match multiple candidates (max 5000) against a single job offer.

**Input modes** (mutually exclusive):
- **Structured**: Provide candidate/offer fields directly (name, skills, experience_years, etc.)
- **Bulk**: Provide raw text/JSON in 'bulk' field - we extract structured data automatically

**Pagination for large requests (> page_size candidates):**
- The `page_size` option (default 100, range: 5-100) controls pagination threshold
- Layer 1 quick sorting is applied to ALL candidates
- Layer 2 deep analysis is run on the first page (page_size candidates)
- A `matching_session_id` is returned for fetching additional pages
- Use `POST /v1/matching-session` with session_id and page number for more results

**Response type:**
- <= page_size candidates: Returns `BatchMatchResultResponse` with direct deep analysis
- > page_size candidates: Returns `PaginatedMatchResultResponse` with session ID
post/v1/match-candidates

Request

  • Base URL: https://api.getyourjob.pro (the document declares no server; this is the origin it was published from)
  • URL: https://api.getyourjob.pro/v1/match-candidates
  • Auth: none declared

Request body

Example request

{
  "description": "Structured mode for candidates and offer",
  "value": {
    "candidates": [
      {
        "experience_years": 5,
        "external_id": "candidate-001",
        "headline": "Senior Full-Stack Developer",
        "name": "John Doe",
        "seniority": "senior",
        "skills": [
          "React",
          "Node.js",
          "TypeScript"
        ]
      },
      {
        "experience_years": 3,
        "external_id": "candidate-002",
        "name": "Jane Smith",
        "seniority": "mid",
        "skills": [
          "Python",
          "Django",
          "PostgreSQL"
        ]
      }
    ],
    "offer": {
      "external_id": "offer-123",
      "required_skills": [
        "React",
        "Node.js"
      ],
      "seniority_required": "senior",
      "title": "Full-Stack Developer"
    },
    "options": {
      "include_analysis": true,
      "min_score_threshold": 5
    }
  }
}

Response

Successful batch match results

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.