API Evangelist conversational phrasing for Aiapplyd Resume Builder API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Resume Builder API
  version: 1.0.0
extends: openapi/aiapplyd-resume-builder-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: 21
- target: $.paths['/resume-builder'].get
  update:
    x-apievangelist-phrasing:
      intent: List my resume builds
      effect: read
      questions:
      - Which resumes have I built so far in the resume builder?
      - Can I see every resume build saved on my AIApplyd account?
      instructions:
      - text: List all of my resume builds.
      - text: Show me the resumes I've built in the builder so I can pick one to edit.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new resume build
      effect: write
      questions:
      - How do I start a new resume from scratch in the builder?
      - Can I create a cover letter build with a recipient company and hiring manager name?
      instructions:
      - text: Create a new resume build titled {title}.
        slots:
          title: requestBody.title
      - text: Start a new resume build called {title} using template {templateId}.
        slots:
          title: requestBody.title
          templateId: requestBody.templateId
      - text: Create a cover letter build titled {title} addressed to {recipientName} at {recipientCompany}.
        slots:
          title: requestBody.title
          recipientName: requestBody.recipientName
          recipientCompany: requestBody.recipientCompany
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List available resume templates
      effect: read
      questions:
      - What resume templates can I choose from?
      - Which layouts are available for designing my resume?
      instructions:
      - text: Show me all the resume templates I can use.
      - text: List the available resume design templates.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn an uploaded document into a resume build
      effect: write
      questions:
      - Can AI convert a resume document I already uploaded into an editable structured resume?
      - Is there a way to create a new resume build from one of my saved documents?
      instructions:
      - text: Import document {documentId} into a new resume build titled {title}.
        slots:
          documentId: requestBody.documentId
          title: requestBody.title
      - text: Parse my uploaded document {documentId} into a resume build called {title} using template {templateId}.
        slots:
          documentId: requestBody.documentId
          title: requestBody.title
          templateId: requestBody.templateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/import-inline'].post
  update:
    x-apievangelist-phrasing:
      intent: Fill an existing resume build from a file
      effect: write
      questions:
      - Can I upload a file straight into a resume build I already started and have it filled in?
      - How do I populate an existing resume build in place from a PDF?
      instructions:
      - text: Upload {file} and use it to fill in resume build {id}.
        slots:
          file: requestBody.file
          id: path.id
      - text: 'Populate existing resume build {id} in place from this file: {file}.'
        slots:
          id: path.id
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one resume build
      effect: read
      questions:
      - What's currently in a specific resume build of mine?
      - Can I open a single resume build to see its sections and template?
      instructions:
      - text: Show me resume build {id}.
        slots:
          id: path.id
      - text: Open the details of resume build {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing resume build
      effect: write
      questions:
      - How do I change the summary or skills on a resume I already built?
      - Can I switch an existing resume build to a different template or font?
      instructions:
      - text: Update the summary on resume build {id} to {summary}.
        slots:
          id: path.id
          summary: requestBody.summary
      - text: Switch resume build {id} to template {templateId}.
        slots:
          id: path.id
          templateId: requestBody.templateId
      - text: Rename resume build {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resume build
      effect: destructive
      questions:
      - How do I get rid of a resume build I no longer need?
      - Can I permanently remove one of my resume builds?
      instructions:
      - text: Delete resume build {id}.
        slots:
          id: path.id
      - text: Remove resume build {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/artifact'].post
  update:
    x-apievangelist-phrasing:
      intent: Save the rendered PDF for a resume build
      effect: write
      questions:
      - Can I publish the exact preview PDF of a resume build without it being re-parsed?
      - Where do I store the rendered PDF for a specific revision of my resume build?
      instructions:
      - text: Save {file} as the rendered PDF for revision {artifactRevision} of resume build {id}.
        slots:
          file: requestBody.file
          artifactRevision: requestBody.artifactRevision
          id: path.id
      - text: Publish the preview PDF {file} for resume build {id} at revision {artifactRevision}.
        slots:
          file: requestBody.file
          id: path.id
          artifactRevision: requestBody.artifactRevision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/set-default'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a resume build my default
      effect: write
      questions:
      - How do I choose which built resume is my default?
      - Can I switch my default resume to a different build?
      instructions:
      - text: Set resume build {id} as my default resume.
        slots:
          id: path.id
      - text: Make {id} my default resume build instead of the current one.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/ats-score'].post
  update:
    x-apievangelist-phrasing:
      intent: Score a resume build for ATS compatibility
      effect: read
      questions:
      - How well would one of my built resumes get through an applicant tracking system?
      - Can I check a resume build's ATS score against a particular job description?
      instructions:
      - text: 'Score resume build {id} for ATS compatibility against this job description: {jobDescription}.'
        slots:
          id: path.id
          jobDescription: requestBody.jobDescription
      - text: Check how ATS-friendly resume build {id} is for the role described as {jobDescription}.
        slots:
          id: path.id
          jobDescription: requestBody.jobDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/ats-optimize'].post
  update:
    x-apievangelist-phrasing:
      intent: Rewrite a resume build to pass ATS
      effect: write
      questions:
      - Can AI rewrite one of my built resumes so it scores better with applicant tracking systems?
      - Is there a one-click ATS optimization for a resume build, tuned to a job posting?
      instructions:
      - text: Optimize resume build {id} for ATS.
        slots:
          id: path.id
      - text: 'Rewrite resume build {id} for ATS using this job description: {jobDescription}.'
        slots:
          id: path.id
          jobDescription: requestBody.jobDescription
      - text: Apply these earlier suggestions {suggestions} when ATS-optimizing resume build {id}.
        slots:
          suggestions: requestBody.suggestions
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/generate-cover-letter'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a cover letter from a resume build
      effect: write
      questions:
      - Can AI write a cover letter based on one of my built resumes?
      - Could the cover letter be targeted at one of my job matches or a specific company?
      instructions:
      - text: Generate a cover letter from resume build {id}.
        slots:
          id: path.id
      - text: Write a cover letter from resume build {id} for the {jobTitle} role at {company}.
        slots:
          id: path.id
          jobTitle: requestBody.jobTitle
          company: requestBody.company
      - text: Draft a cover letter from resume build {id} targeting job match {jobMatchId}.
        slots:
          id: path.id
          jobMatchId: requestBody.jobMatchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/translate'].post
  update:
    x-apievangelist-phrasing:
      intent: Translate a resume build into other languages
      effect: write
      questions:
      - Can I get my built resume translated into German and Spanish?
      - Does translating a resume build create a separate build for each language?
      instructions:
      - text: Translate resume build {id} into {targetLanguage}.
        slots:
          id: path.id
          targetLanguage: requestBody.targetLanguage
      - text: 'Make copies of resume build {id} in each of these languages: {targetLanguages}.'
        slots:
          id: path.id
          targetLanguages: requestBody.targetLanguages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/share'].post
  update:
    x-apievangelist-phrasing:
      intent: Share or unshare a resume build publicly
      effect: write
      questions:
      - How do I get a public link to one of my built resumes?
      - Can I turn off public visibility for a resume build I shared earlier?
      instructions:
      - text: Make resume build {id} public and give me a share link.
        slots:
          id: path.id
      - text: Set public sharing for resume build {id} to {isPublic}.
        slots:
          id: path.id
          isPublic: requestBody.isPublic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/chat-thread'].get
  update:
    x-apievangelist-phrasing:
      intent: Load the AI chat for a resume build
      effect: read
      questions:
      - Can I see the chat conversation I had with the assistant while editing a resume build?
      - What did the builder's AI chat say about my resume last time?
      instructions:
      - text: Load the chat thread for resume build {id}.
        slots:
          id: path.id
      - text: Show the saved assistant conversation on resume build {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/chat-thread'].put
  update:
    x-apievangelist-phrasing:
      intent: Save the AI chat for a resume build
      effect: write
      questions:
      - Is the resume builder's chat history persisted between sessions?
      - Can I store a set of chat messages against a specific resume build?
      instructions:
      - text: Save these chat messages {messages} on resume build {id}.
        slots:
          messages: requestBody.messages
          id: path.id
      - text: Persist the current assistant conversation {messages} for resume build {id}.
        slots:
          messages: requestBody.messages
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/shared/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a publicly shared resume
      effect: read
      questions:
      - Can someone without an account open a resume shared from the builder?
      - What does a shared resume link show to a recruiter?
      instructions:
      - text: Open the shared resume with token {token}.
        slots:
          token: path.token
      - text: View the public resume behind share link token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/tex'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a resume build as LaTeX source
      effect: read
      questions:
      - Can I download my resume as a .tex file to edit in Overleaf?
      - Is there a LaTeX version of a resume build I can get?
      instructions:
      - text: Generate the LaTeX source for resume build {id}.
        slots:
          id: path.id
      - text: Give me resume build {id} as a .tex file for Overleaf.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cover-letter/suggest-tone'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest a cover letter tone for a job match
      effect: read
      questions:
      - What tone should my cover letter take for a particular job match?
      - Can AI recommend a persona preset for a cover letter based on the job's description?
      instructions:
      - text: Suggest a cover letter tone for job match {jobMatchId}.
        slots:
          jobMatchId: requestBody.jobMatchId
      - text: Recommend which voice preset to use when writing to job match {jobMatchId}, with a reason.
        slots:
          jobMatchId: requestBody.jobMatchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resume-builder/{id}/suggest-section'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest content for a blank resume section
      effect: read
      questions:
      - Can the builder fill an empty section using what's in my other resumes?
      - How many suggested items does it give me for a blank resume section?
      instructions:
      - text: Suggest items for the {sectionType} section of resume build {id}.
        slots:
          sectionType: requestBody.sectionType
          id: path.id
      - text: 'Draft {sectionType} entries for resume build {id} with this context: {anchorContext}.'
        slots:
          sectionType: requestBody.sectionType
          id: path.id
          anchorContext: requestBody.anchorContext
      method: generated
      generated: '2026-09-26'