API Evangelist conversational phrasing for Aiapplyd Applications 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 Applications API
  version: 1.0.0
extends: openapi/aiapplyd-applications-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: 40
- target: $.paths['/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my job application results
      effect: read
      questions:
      - Which of my auto-applied job applications are still pending review?
      - Can I filter my applications by hiring stage like interview or offered?
      - What applications has AI Applyd submitted for me this week?
      instructions:
      - text: List my applications sorted by best match.
      - text: Show my applications at {company_or_title} created since {since}.
        slots:
          company_or_title: query.search
          since: query.since
      - text: List my applications with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my rolling 30-day auto-apply cap
      effect: read
      questions:
      - How many auto-applies do I have left in my 30-day cap?
      - When does my auto-apply limit reset?
      instructions:
      - text: Show how much of my auto-apply cap I've used.
      - text: Tell me whether I'm still allowed to auto-apply right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/prepare'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a tailored resume and cover letter
      effect: write
      questions:
      - Can the AI tailor my resume and write a cover letter for one job match?
      - How do I get an application package ready for a job I matched with?
      instructions:
      - text: Prepare an application package for job match {jobMatchId}.
        slots:
          jobMatchId: requestBody.jobMatchId
      - text: Tailor my resume and cover letter for job match {jobMatchId} in {mode} mode.
        slots:
          jobMatchId: requestBody.jobMatchId
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/results/approve-batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk approve pending applications
      effect: write
      questions:
      - Can I approve a whole batch of pending-review applications at once?
      - What happens if one application fails when I approve up to 25 together?
      instructions:
      - text: 'Approve these pending applications in one go: {resultIds}.'
        slots:
          resultIds: requestBody.resultIds
      - text: Bulk approve pending-review results {resultIds} for submission.
        slots:
          resultIds: requestBody.resultIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/by-id/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one application result
      effect: read
      questions:
      - Where can I see the full details of a single application result?
      - What status is one specific application of mine in?
      instructions:
      - text: Show application result {resultId}.
        slots:
          resultId: path.resultId
      - text: Get the details of my application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a pending application in copilot mode
      effect: write
      questions:
      - How do I approve one application that's waiting for my review in copilot mode?
      - Can I mark a single reviewed application as ready to submit?
      instructions:
      - text: Approve pending application {resultId} so it's ready to submit.
        slots:
          resultId: path.resultId
      - text: Sign off on copilot application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a pending application in copilot mode
      effect: write
      questions:
      - Can I skip an application the copilot prepared instead of submitting it?
      - What happens when I reject a pending-review application?
      instructions:
      - text: Reject pending application {resultId}.
        slots:
          resultId: path.resultId
      - text: Skip copilot application {resultId} instead of sending it.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed submission (admin only)
      effect: write
      questions:
      - Can an admin re-queue an application whose submission failed?
      - Is there a way to retry a failed auto-apply submission as an admin?
      instructions:
      - text: As an admin, retry the failed submission of application {resultId}.
        slots:
          resultId: path.resultId
      - text: Re-enqueue application {resultId} for submission after it failed.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/retry-prep'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed preparation (admin only)
      effect: write
      questions:
      - Can an admin restart preparation for an application stuck while preparing?
      - Is there a way to rerun a failed application preparation step as an admin?
      instructions:
      - text: As an admin, retry preparation for stuck application {resultId}.
        slots:
          resultId: path.resultId
      - text: Re-enqueue application {resultId} for preparation after it failed.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an auto-apply before it submits
      effect: destructive
      questions:
      - Can I stop an auto-apply while it's still queued or preparing?
      - Why would cancelling an application return a conflict once the browser session started?
      instructions:
      - text: Cancel auto-apply {resultId} before it gets submitted.
        slots:
          resultId: path.resultId
      - text: Stop queued application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/screenshot/{variant}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a before or after submission screenshot
      effect: read
      questions:
      - Can I see a screenshot of the form right after my application was submitted?
      - Is there a picture of the filled-in application before it was sent?
      instructions:
      - text: Show the {variant} submission screenshot for application {resultId}.
        slots:
          variant: path.variant
          resultId: path.resultId
      - text: Download the after-submit screenshot of application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/by-job-match/{jobMatchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest application for a job match
      effect: read
      questions:
      - Did I already apply to the job behind a given job match?
      - Which application result is linked to a specific job match?
      instructions:
      - text: Show the most recent application for job match {jobMatchId}.
        slots:
          jobMatchId: path.jobMatchId
      - text: Find my application result for job match {jobMatchId}.
        slots:
          jobMatchId: path.jobMatchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/live-view'].get
  update:
    x-apievangelist-phrasing:
      intent: Watch an in-progress apply session live
      effect: read
      questions:
      - Can I watch the browser while it's filling out my application?
      - Is there a live view link for an application being submitted right now?
      instructions:
      - text: Get the live view URL for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Let me watch the apply session for {resultId} live.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/stage'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an application's hiring stage
      effect: write
      questions:
      - How do I record that an application moved to the interview stage?
      - Can I mark an application result as offered?
      instructions:
      - text: Set the stage of application {resultId} to {applicationStage}.
        slots:
          resultId: path.resultId
          applicationStage: requestBody.applicationStage
      - text: Move application result {resultId} to interview.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/extract-form'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract and pre-fill an application's form fields
      effect: write
      questions:
      - Can the AI read the application form and propose answers to the screening questions?
      - How do I get the proposed form values for a copilot review?
      instructions:
      - text: Extract and map the form fields for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Pre-fill the form and screening answers for application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/form-values'].put
  update:
    x-apievangelist-phrasing:
      intent: Save edited form values before submission
      effect: write
      questions:
      - Can I correct the form answers before my application is submitted?
      - Where do I save my edited screening question answers?
      instructions:
      - text: Save form values {formFields} for application {resultId}.
        slots:
          formFields: requestBody.formFields
          resultId: path.resultId
      - text: Update application {resultId} with screening answers {screeningAnswers} and fields {formFields}.
        slots:
          resultId: path.resultId
          screeningAnswers: requestBody.screeningAnswers
          formFields: requestBody.formFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/download/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a tailored resume or cover letter PDF
      effect: read
      questions:
      - Can I download the tailored resume PDF that was sent with an application?
      - Where do I get the cover letter PDF for one of my applications?
      instructions:
      - text: Download the {type} PDF for application {resultId}.
        slots:
          type: path.type
          resultId: path.resultId
      - text: Get the cover letter PDF for application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/submission-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's submission activity
      effect: read
      questions:
      - What submission attempts were made for one of my applications?
      - Can I see the form field log and activity timeline for a submission?
      instructions:
      - text: Show the submission info for application {resultId}.
        slots:
          resultId: path.resultId
      - text: List the submission attempts and field log for {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/generate-outreach'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate recruiter outreach for an application
      effect: write
      questions:
      - Can it write LinkedIn connection requests and cold emails for an application?
      - How do I get follow-up message ideas for a job I applied to?
      instructions:
      - text: Generate recruiter outreach messages for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Write a LinkedIn note, follow-up and cold email for application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/refine'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a tailored document with my instructions
      effect: write
      questions:
      - Can I ask the AI to rewrite my tailored cover letter with specific instructions?
      - How do I regenerate a tailored resume emphasizing different experience?
      instructions:
      - text: 'Refine the {documentType} for application {resultId}: {userInstructions}.'
        slots:
          documentType: requestBody.documentType
          resultId: path.resultId
          userInstructions: requestBody.userInstructions
      - text: 'Regenerate the tailored resume for {resultId} with these instructions: {userInstructions}.'
        slots:
          resultId: path.resultId
          userInstructions: requestBody.userInstructions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/document'].patch
  update:
    x-apievangelist-phrasing:
      intent: Save a chat-edited tailored document
      effect: write
      questions:
      - How do I save the edits I made to a tailored resume in chat and rebuild its PDF?
      - Can I persist my own changes to an application's cover letter text?
      instructions:
      - text: 'Save this edited {documentType} content to application {resultId}: {content}.'
        slots:
          documentType: requestBody.documentType
          resultId: path.resultId
          content: requestBody.content
      - text: Apply patch {patchCount} of {documentType} content {content} to application {resultId}.
        slots:
          patchCount: requestBody.patchCount
          documentType: requestBody.documentType
          content: requestBody.content
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/parse-tailored-resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a tailored resume into structured data
      effect: read
      questions:
      - Can I get the tailored resume for an application as structured sections instead of markdown?
      - How is a tailored resume turned into editable blocks for preview?
      instructions:
      - text: Parse the tailored resume of application {resultId} into structured data.
        slots:
          resultId: path.resultId
      - text: Convert application {resultId}'s tailored resume markdown to resume blocks.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/staleness'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a prepared application is stale
      effect: read
      questions:
      - Is my prepared application out of date after I changed my AI settings?
      - Which prepare steps would rerun if I re-prepared an application?
      instructions:
      - text: Check whether application {resultId} is stale.
        slots:
          resultId: path.resultId
      - text: Show which steps of {resultId} are out of date.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/re-prepare'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-prepare the stale steps of an application
      effect: write
      questions:
      - Can I rerun only the outdated steps of a prepared application?
      - Will re-preparing an application keep the steps that aren't stale?
      instructions:
      - text: Re-prepare stale application {resultId}.
        slots:
          resultId: path.resultId
      - text: Rerun steps {steps} for application {resultId}.
        slots:
          steps: requestBody.steps
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/switch-document'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap the resume or cover letter on an application
      effect: write
      questions:
      - Can I send my base resume instead of the tailored one for an application?
      - Does switching which document an application uses cost AI tokens?
      instructions:
      - text: Switch the {kind} on application {resultId} to {target}.
        slots:
          kind: requestBody.kind
          resultId: path.resultId
          target: requestBody.target
      - text: Use my document {documentId} as the {kind} for application {resultId}.
        slots:
          documentId: requestBody.documentId
          kind: requestBody.kind
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/negotiate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get salary negotiation scripts for an offer
      effect: read
      questions:
      - What should I say when negotiating an offer I received?
      - Why can't I get negotiation scripts before the application reaches the offered stage?
      instructions:
      - text: Get negotiation scripts for offer {resultId}.
        slots:
          resultId: path.resultId
      - text: Show me how to negotiate the offer on application {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/negotiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate negotiation scripts
      effect: write
      questions:
      - Can I force fresh negotiation scripts instead of the cached ones?
      - Can I prep negotiation scripts before the offer actually arrives?
      instructions:
      - text: Regenerate the negotiation scripts for application {resultId}.
        slots:
          resultId: path.resultId
      - text: 'Force new negotiation scripts for {resultId} even before an offer: {force}.'
        slots:
          resultId: path.resultId
          force: requestBody.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/generation-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check interview prep and negotiation generation status
      effect: read
      questions:
      - Is the interview prep for my application still generating?
      - Has the negotiation coach finished for one of my applications?
      instructions:
      - text: Check the AI generation status for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Tell me if interview prep and negotiation are done for {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/queue-position'].get
  update:
    x-apievangelist-phrasing:
      intent: See an application's place in the apply queue
      effect: read
      questions:
      - How many applications are ahead of mine in the auto-apply queue?
      - Is my application already being processed or still waiting in line?
      instructions:
      - text: Show the queue position of application {resultId}.
        slots:
          resultId: path.resultId
      - text: How far back in line is application {resultId}? Tell me.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/pipeline-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my overall apply pipeline snapshot
      effect: read
      questions:
      - How busy is the auto-apply queue across the platform right now?
      - How many of my applications are waiting versus processing overall?
      instructions:
      - text: Show my apply pipeline status.
      - text: Summarize how many of my rows are queued and processing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{jobId}/level-strategy'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a seniority level strategy for a job
      effect: write
      questions:
      - Should I pitch myself as senior or take a downlevel for a particular role, based on levels?
      - Can I get a plan for when my level is above the job's level?
      instructions:
      - text: 'Generate a level strategy for job {jobId}: I''m {userLevel}, the role is {jdLevel}.'
        slots:
          jobId: path.jobId
          userLevel: requestBody.userLevel
          jdLevel: requestBody.jdLevel
      - text: Build the Block C level plan for job {jobId} at level {jdLevel} versus my {userLevel}.
        slots:
          jobId: path.jobId
          jdLevel: requestBody.jdLevel
          userLevel: requestBody.userLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/personalization-plan'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate CV and LinkedIn changes for a job match
      effect: write
      questions:
      - What are the top resume and LinkedIn changes I should make for a specific job match?
      - Which ATS keywords from a job description should I add to my CV?
      instructions:
      - text: Generate a personalization plan for job match {jobMatchId}.
        slots:
          jobMatchId: requestBody.jobMatchId
      - text: List the top CV and LinkedIn edits for job match {jobMatchId}.
        slots:
          jobMatchId: requestBody.jobMatchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/recover-stuck'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover my stuck applications
      effect: write
      questions:
      - My applications seem stuck preparing, can I clean them up?
      - What happens to timed-out preparations when I trigger recovery?
      instructions:
      - text: Recover my stuck applications.
      - text: Mark my timed-out application preparations as failed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ai-edit/open'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an AI edit session on an application's resume
      effect: write
      questions:
      - How do I start editing an application's resume with AI in a draft?
      - How long does an AI edit draft stay alive?
      instructions:
      - text: Open an AI edit session for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Start an AI edit draft of the {scope} on application {resultId}.
        slots:
          scope: requestBody.scope
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ai-edit/rewind'].post
  update:
    x-apievangelist-phrasing:
      intent: Undo steps in an AI edit session
      effect: write
      questions:
      - Can I roll back the last few AI edits I made to a draft resume?
      - Is it possible to undo edits back to an earlier message in the session?
      instructions:
      - text: Rewind AI edit session {sessionId} on application {resultId} to message {messageIdx}.
        slots:
          sessionId: requestBody.sessionId
          resultId: path.resultId
          messageIdx: requestBody.messageIdx
      - text: Undo every edit from message {messageIdx} onward in session {sessionId} for {resultId}.
        slots:
          messageIdx: requestBody.messageIdx
          sessionId: requestBody.sessionId
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ai-edit/finalize'].post
  update:
    x-apievangelist-phrasing:
      intent: Finalize an AI edit session into a document
      effect: write
      questions:
      - How do I keep the draft from an AI edit session as the application's resume?
      - What happens to the draft after I finalize my AI edits?
      instructions:
      - text: Finalize AI edit session {sessionId} for application {resultId}.
        slots:
          sessionId: requestBody.sessionId
          resultId: path.resultId
      - text: Save the AI-edited draft {sessionId} as application {resultId}'s tailored resume.
        slots:
          sessionId: requestBody.sessionId
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ai-edit/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview an AI edit draft as PDF
      effect: read
      questions:
      - Can I see what my AI-edited resume draft looks like as a PDF before saving?
      - Which template is used when previewing an AI edit draft?
      instructions:
      - text: Preview AI edit session {sessionId} of application {resultId} as a PDF.
        slots:
          sessionId: query.sessionId
          resultId: path.resultId
      - text: Render the current draft for session {sessionId} on {resultId}.
        slots:
          sessionId: query.sessionId
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ai-edit/available-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List which documents I can AI-edit
      effect: read
      questions:
      - Which documents on an application can I refine with AI edit?
      - Why is the cover letter not available for AI editing on some applications?
      instructions:
      - text: List the AI edit scopes available for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Tell me which documents of {resultId} are editable with AI.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ats-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List ATS accounts created on my behalf
      effect: read
      questions:
      - Which job portal accounts did the service create for me when applying?
      - Can I see the candidate logins made for an application behind an ATS login wall?
      instructions:
      - text: List the ATS accounts created for application {resultId}.
        slots:
          resultId: path.resultId
      - text: Show the candidate portal logins made for {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{resultId}/ats-credentials/{credentialId}/reveal'].post
  update:
    x-apievangelist-phrasing:
      intent: Reveal a created ATS account's password
      effect: read
      questions:
      - How do I see the password of a job portal account made for me?
      - Is revealing a created ATS password recorded anywhere?
      instructions:
      - text: Reveal the password for ATS account {credentialId} on application {resultId}.
        slots:
          credentialId: path.credentialId
          resultId: path.resultId
      - text: Show me the login password for credential {credentialId} of {resultId}.
        slots:
          credentialId: path.credentialId
          resultId: path.resultId
      method: generated
      generated: '2026-09-26'