Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Application API

4 actions 4 updates phrasing extends openapi/bindbee-application-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bindbee's API. It is a proposal applied on top of the contract, not a document Bindbee publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/ats/v1/applications'].get

$.paths['/api/ats/v1/applications'].post

$.paths['/api/ats/v1/applications/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Application API
  version: 1.0.0
extends: openapi/bindbee-application-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/ats/v1/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List job applications in the ATS
      effect: read
      questions:
      - Which applications have been submitted for a given job opening?
      - Can I filter applications by their current interview stage or reject reason?
      - What applications did a specific candidate make?
      instructions:
      - text: List applications for job {job}.
        slots:
          job: query.job
      - text: Show applications currently at stage {current_stage}.
        slots:
          current_stage: query.current_stage
      - text: Find applications from candidate {candidate} that came in via source {source}.
        slots:
          candidate: query.candidate
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a new job application
      effect: write
      questions:
      - How do I push a new application for a candidate into the connected ATS?
      - Can I create an application record through the unified recruiting endpoint?
      instructions:
      - text: Create a new job application in the ATS linked to connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Submit an application record for a candidate to a job opening.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one job application by id
      effect: read
      questions:
      - What stage is a particular application in right now?
      - Can I see the full details of one application including custom fields?
      instructions:
      - text: Get application {id}.
        slots:
          id: path.id
      - text: Retrieve application {id} with its custom fields included.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'