AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Onboarding API

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

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/onboarding/parse-resume'].post
$.paths['/onboarding/auto-setup'].post
$.paths['/onboarding/discover-status'].get
$.paths['/onboarding/profile'].get
$.paths['/onboarding/profile'].post
$.paths['/onboarding/resume-prefill'].get
$.paths['/onboarding/complete'].post
$.paths['/onboarding/escrow'].post
$.paths['/onboarding/escrow/redeem'].post

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 Aiapplyd Onboarding API
  version: 1.0.0
extends: openapi/aiapplyd-onboarding-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: 9
- target: $.paths['/onboarding/parse-resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a resume to start my profile
      effect: write
      questions:
      - Can I upload my resume during sign-up and have my profile filled from it?
      - Which file formats does onboarding accept for resume parsing?
      instructions:
      - text: Parse my resume {file} for onboarding.
        slots:
          file: requestBody.file
      - text: Extract my profile details from already-uploaded document {documentId} during setup.
        slots:
          documentId: requestBody.documentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/auto-setup'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up my account and matches from my resume
      effect: write
      questions:
      - Can onboarding create my job preferences and kick off job searches in one step?
      - What details do I need to supply to finish automatic setup from my parsed resume?
      instructions:
      - text: Auto-setup my account as {fullName} in {city}, {state}, {country} with email {email} and phone {phone}.
        slots:
          fullName: requestBody.fullName
          city: requestBody.city
          state: requestBody.state
          country: requestBody.country
          email: requestBody.email
          phone: requestBody.phone
      - text: Finish setup targeting {suggestedJobTitles} in {suggestedLocations} with skills {skills} and work styles {workStyles}.
        slots:
          suggestedJobTitles: requestBody.suggestedJobTitles
          suggestedLocations: requestBody.suggestedLocations
          skills: requestBody.skills
          workStyles: requestBody.workStyles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/discover-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check first-time match discovery progress
      effect: read
      questions:
      - Is the initial job search after setup still running or did it fail?
      - When will my first matches be ready after onboarding?
      instructions:
      - text: Check the status of my background match discovery.
      - text: Tell me whether the job discovery started by setup has finished.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my onboarding wizard answers
      effect: read
      questions:
      - What answers did I give in the onboarding wizard?
      - Have I started the setup questionnaire yet?
      instructions:
      - text: Show my onboarding wizard answers.
      - text: Load what I entered so far in the setup questionnaire.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Save answers from the onboarding wizard
      effect: write
      questions:
      - Can I save my wizard answers one screen at a time?
      - Where do I record my job timeline and target interviews per week during setup?
      instructions:
      - text: Save my onboarding roles as {roles}.
        slots:
          roles: requestBody.roles
      - text: Record my goal {goal} and a target of {interviewsPerWeekTarget} interviews per week.
        slots:
          goal: requestBody.goal
          interviewsPerWeekTarget: requestBody.interviewsPerWeekTarget
      - text: Set my wizard salary range to {salaryMin}-{salaryMax}.
        slots:
          salaryMin: requestBody.salaryMin
          salaryMax: requestBody.salaryMax
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/resume-prefill'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields came from my resume
      effect: read
      questions:
      - Which of my profile fields are still using what was read from my resume?
      - What cities from my resume can I pick as location options?
      instructions:
      - text: Show which profile and preference fields were prefilled from my base resume.
      - text: List the resume cities I can offer as location chips.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish onboarding
      effect: write
      questions:
      - What happens when I complete the setup wizard?
      - Can I pick an auto-apply mode as I finish onboarding?
      instructions:
      - text: Complete my onboarding.
      - text: Finish onboarding with auto-apply mode {autoApplyMode}.
        slots:
          autoApplyMode: requestBody.autoApplyMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/escrow'].post
  update:
    x-apievangelist-phrasing:
      intent: Hold anonymous setup answers before sign-in
      effect: write
      questions:
      - Will my answers survive if I open the magic sign-in link in a different browser?
      - Can pre-signup answers be stored server-side and referenced later?
      instructions:
      - text: Store my answers {answers} from screen {screen} before I sign in.
        slots:
          answers: requestBody.answers
          screen: requestBody.screen
      - text: Mint an escrow reference for the answers {answers} at screen {screen}.
        slots:
          answers: requestBody.answers
          screen: requestBody.screen
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/escrow/redeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover setup answers after sign-in
      effect: write
      questions:
      - Can I get back the answers I gave before signing in?
      - What's returned when an escrow reference has expired or was already used?
      instructions:
      - text: Redeem escrow reference {ref} to recover my answers.
        slots:
          ref: requestBody.ref
      - text: Exchange {ref} for the saved pre-signup answers.
        slots:
          ref: requestBody.ref
      method: generated
      generated: '2026-09-26'