KEBA · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for eRecruiter Applicant API

7 actions 7 updates phrasing extends openapi/keba-applicant-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for KEBA's API. It is a proposal applied on top of the contract, not a document KEBA publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/Api/Applicant/{applicantId}'].get
$.paths['/Api/Applicant/{applicantId}'].post
$.paths['/Api/Applicant/{applicantId}'].delete
$.paths['/Api/Applicant'].get
$.paths['/Api/Applicant'].put
$.paths['/Api/Applicant/CoverLetter/{applicantId}'].put

OpenAPI Overlay

keba-applicant-api-phrasing-overlay.yaml Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for eRecruiter Applicant API
  version: 1.0.0
extends: openapi/keba-applicant-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/Api/Applicant/{applicantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an applicant profile by ID
      effect: read
      questions:
      - How do I look up an applicant's profile using their ID?
      - Can I fetch one applicant's details from the applicant portal?
      instructions:
      - text: Get applicant profile {applicantId}.
        slots:
          applicantId: path.applicantId
      - text: Show the applicant with ID {applicantId}.
        slots:
          applicantId: path.applicantId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/Api/Applicant/{applicantId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing applicant profile
      effect: write
      questions:
      - How do I update an applicant's profile that already exists?
      - Can I change an applicant's salary or location after they registered?
      instructions:
      - text: Update applicant {applicantId} with email {email}.
        slots:
          applicantId: path.applicantId
          email: requestBody.Email
      - text: Set applicant {applicantId}'s salary to {salary}.
        slots:
          applicantId: path.applicantId
          salary: requestBody.Salary
      method: generated
      generated: '2026-11-20'
- target: $.paths['/Api/Applicant/{applicantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an applicant profile
      effect: destructive
      questions:
      - How do I delete an applicant's profile from the portal?
      - Can I completely remove an applicant instead of just anonymizing them?
      instructions:
      - text: Delete applicant {applicantId}.
        slots:
          applicantId: path.applicantId
      - text: Completely remove applicant {applicantId} from the database.
        slots:
          applicantId: path.applicantId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/Api/Applicant'].get
  update:
    x-apievangelist-phrasing:
      intent: Log in to an applicant's profile
      effect: read
      questions:
      - How does an applicant log in to their profile with their email and password?
      - Can I fetch an applicant's profile using their credentials?
      instructions:
      - text: Log in to applicant {usernameOrEmail} with password {password}.
        slots:
          usernameOrEmail: query.usernameOrEmail
          password: query.password
      - text: Fetch the applicant profile for {usernameOrEmail}.
        slots:
          usernameOrEmail: query.usernameOrEmail
      method: generated
      generated: '2026-11-20'
- target: $.paths['/Api/Applicant'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a new applicant profile
      effect: write
      questions:
      - How do I create a new applicant profile through the API?
      - Can I send a registration email when creating an applicant?
      instructions:
      - text: Create applicant {firstName} {lastName} with email {email}.
        slots:
          firstName: requestBody.FirstName
          lastName: requestBody.LastName
          email: requestBody.Email
      - text: Create applicant {email} and send the registration email.
        slots:
          email: requestBody.Email
      method: generated
      generated: '2026-11-20'
- target: $.paths['/Api/Applicant/CoverLetter/{applicantId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a cover letter to an applicant
      effect: write
      questions:
      - How do I attach a cover letter to an existing applicant?
      - Can I add a cover letter for a specific job to an applicant's profile?
      instructions:
      - text: Add cover letter {coverLetter} to applicant {applicantId}.
        slots:
          coverLetter: requestBody.CoverLetter
          applicantId: path.applicantId
      - text: Attach a cover letter for job {jobId} to applicant {applicantId}.
        slots:
          jobId: requestBody.JobId
          applicantId: path.applicantId
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/keba-applicant-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.