Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Scheduled Interview API

4 actions 4 updates phrasing extends openapi/bindbee-scheduled-interview-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/scheduled-interviews'].get
$.paths['/api/ats/v1/scheduled-interviews'].post
$.paths['/api/ats/v1/scheduled-interviews/{id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Scheduled Interview API
  version: 1.0.0
extends: openapi/bindbee-scheduled-interview-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/scheduled-interviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled interviews
      effect: read
      questions:
      - Which interviews are scheduled for a given application?
      - Can I see interviews organized by a particular user or at a certain stage?
      instructions:
      - text: List interviews for application {application}.
        slots:
          application: query.application
      - text: Show interviews organized by {organizer}.
        slots:
          organizer: query.organizer
      - text: Find interviews at stage {job_interview_stage}.
        slots:
          job_interview_stage: query.job_interview_stage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/scheduled-interviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an interview
      effect: write
      questions:
      - How do I put a new interview on the calendar in the ATS?
      - Can I create scheduled interviews through the unified API?
      instructions:
      - text: Schedule a new interview in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Book an interview for a candidate's application.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/scheduled-interviews/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled interview
      effect: read
      questions:
      - When and with whom is a specific interview scheduled?
      - Can I fetch one scheduled interview by id?
      instructions:
      - text: Get scheduled interview {id}.
        slots:
          id: path.id
      - text: Retrieve interview {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'