FlashApply API Docs
Need help?
Back to Search & Ranking

Keyword Search

Performs a keyword/Boolean search on resumes or jobs with optional filters and field scoping. Supports operators (AND, OR, NOT), quotes for phrases, and field queries (e.g., skills:React).

Sample Request & Response

POST
/v1/search/keyword
Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>",
  "Content-Type": "application/json"
}

Body:

{
  "query": "(React OR Vue) AND TypeScript",
  "target": "resumes",
  "filters": {
    "location": "Canada",
    "seniority": "mid"
  },
  "topK": 10,
  "sort": "relevance",
  "highlight": true,
  "fields": [
    "name",
    "title",
    "skills"
  ]
}
Sample Response (200)
{
  "results": [
    {
      "id": "resume_456",
      "score": 0.86,
      "metadata": {
        "name": "John Smith",
        "title": "Frontend Developer",
        "location": "Calgary, Canada",
        "skills": [
          "React",
          "TypeScript",
          "Redux"
        ]
      },
      "highlights": [
        "Built a <em>React</em> + <em>TypeScript</em> design system used across 5 apps"
      ]
    }
  ]
}