Generated by API Evangelist
Written by API Evangelist tooling for GetMattered's API. It is a proposal applied on top of the contract, not a document GetMattered publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for GetMattered AI API
version: 1.0.0
extends: openapi/getmattered-ai-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: 6
- target: $.paths['/ai/status'].get
update:
x-apievangelist-phrasing:
intent: Check my AI auto-apply status and stats
effect: read
questions:
- Is the AI applying to jobs for me, and how many has it handled?
- Can I see AI application results filtered by status?
instructions:
- text: Show my AI status and stats.
- text: List my AI application results with status {status}.
slots:
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/ai/activate'].post
update:
x-apievangelist-phrasing:
intent: Turn on the AI job-application agent
effect: write
questions:
- How do I switch on AI applying for my account?
- What happens if I activate AI when it's already on?
instructions:
- text: Activate AI for my account.
- text: Turn on the AI agent and set up my persona if missing.
method: generated
generated: '2026-09-26'
- target: $.paths['/ai/quality-check'].post
update:
x-apievangelist-phrasing:
intent: Check if a job passes the quality gate
effect: read
questions:
- Would the AI consider a given job good enough to apply to?
- Can I test a job description against the pre-apply quality gate with my resume?
instructions:
- text: 'Run the quality gate on this job: {jobDescription}.'
slots:
jobDescription: requestBody.jobDescription
- text: Check {jobDescription} against the quality criteria using resume text {resumeContent}.
slots:
jobDescription: requestBody.jobDescription
resumeContent: requestBody.resumeContent
method: generated
generated: '2026-09-26'
- target: $.paths['/ai/quality-stats'].get
update:
x-apievangelist-phrasing:
intent: Get quality gate statistics
effect: read
questions:
- How many jobs has the quality gate passed or blocked for me?
- What do the aggregated quality check numbers look like?
instructions:
- text: Show my quality gate statistics.
- text: Summarize how the pre-apply quality gate has scored my jobs.
method: generated
generated: '2026-09-26'
- target: $.paths['/ai/run'].post
update:
x-apievangelist-phrasing:
intent: Run AI on my eligible job matches
effect: write
questions:
- Can I make the AI process my eligible matches right now?
- Does running AI prepare application materials for each match?
instructions:
- text: Run AI processing on my eligible matches now.
- text: Prepare application materials for my eligible job matches.
method: generated
generated: '2026-09-26'
- target: $.paths['/ai/quota'].get
update:
x-apievangelist-phrasing:
intent: Check my AI application quota
effect: read
questions:
- How many AI applications do I have left today?
- What are my weekly and monthly AI application limits?
instructions:
- text: Show my AI application quota usage.
- text: Tell me my remaining daily, weekly and monthly AI applications.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.